Package com.oracle.bmc.vault.requests

Class ListSecretsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.vault.requests.ListSecretsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180608")
public class ListSecretsRequest
extends BmcRequest<Void>

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/vault/ListSecretsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSecretsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListSecretsRequest.Builder
static class	ListSecretsRequest.SortBy	The field to sort by.
static class	ListSecretsRequest.SortOrder	The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor	Description
ListSecretsRequest()

Method Summary

Modifier and Type	Method	Description
static ListSecretsRequest.Builder	builder()	Return a new builder for this request object.
boolean	equals(Object o)	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId()	The OCID of the compartment.
SecretSummary.LifecycleState	getLifecycleState()	A filter that returns only resources that match the specified lifecycle state.
Integer	getLimit()	The maximum number of items to return in a paginated “List” call.
String	getName()	The secret name.
String	getOpcRequestId()	Unique identifier for the request.
String	getPage()	The value of the opc-next-page response header from the previous “List” call.
ListSecretsRequest.SortBy	getSortBy()	The field to sort by.
ListSecretsRequest.SortOrder	getSortOrder()	The sort order to use, either ascending (ASC) or descending (DESC).
String	getVaultId()	The OCID of the vault.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListSecretsRequest.Builder	toBuilder()	Return an instance of ListSecretsRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListSecretsRequest

public ListSecretsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getName

public String getName()

The secret name.

getLimit

public Integer getLimit()

The maximum number of items to return in a paginated “List” call.

getPage

public String getPage()

The value of the opc-next-page response header from the previous “List” call.

getOpcRequestId

public String getOpcRequestId()

Unique identifier for the request.

If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

getSortBy

public ListSecretsRequest.SortBy getSortBy()

The field to sort by.

You can specify only one sort order. The default order for TIMECREATED is descending. The default order for NAME is ascending.

getSortOrder

public ListSecretsRequest.SortOrder getSortOrder()

The sort order to use, either ascending (ASC) or descending (DESC).

getVaultId

public String getVaultId()

The OCID of the vault.

getLifecycleState

public SecretSummary.LifecycleState getLifecycleState()

A filter that returns only resources that match the specified lifecycle state.

The state value is case-insensitive.

toBuilder

public ListSecretsRequest.Builder toBuilder()

Return an instance of ListSecretsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListSecretsRequest.Builder that allows you to modify request properties.

builder

public static ListSecretsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>