Package com.oracle.bmc.vault.requests

Class ListSecretsRequest.Builder

java.lang.Object

com.oracle.bmc.vault.requests.ListSecretsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSecretsRequest,Void>

Enclosing class:

ListSecretsRequest

public static class ListSecretsRequest.Builder
extends Object
implements BmcRequest.Builder<ListSecretsRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListSecretsRequest	build()	Build the instance of ListSecretsRequest as configured by this builder
ListSecretsRequest	buildWithoutInvocationCallback()	Build the instance of ListSecretsRequest as configured by this builder
ListSecretsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListSecretsRequest.Builder	copy(ListSecretsRequest o)	Copy method to populate the builder with values from the given instance.
ListSecretsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListSecretsRequest.Builder	lifecycleState(SecretSummary.LifecycleState lifecycleState)	A filter that returns only resources that match the specified lifecycle state.
ListSecretsRequest.Builder	limit(Integer limit)	The maximum number of items to return in a paginated “List” call.
ListSecretsRequest.Builder	name(String name)	The secret name.
ListSecretsRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
ListSecretsRequest.Builder	page(String page)	The value of the opc-next-page response header from the previous “List” call.
ListSecretsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListSecretsRequest.Builder	sortBy(ListSecretsRequest.SortBy sortBy)	The field to sort by.
ListSecretsRequest.Builder	sortOrder(ListSecretsRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListSecretsRequest.Builder	vaultId(String vaultId)	The OCID of the vault.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListSecretsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

name

public ListSecretsRequest.Builder name(String name)

The secret name.

Parameters:

name - the value to set

Returns:

this builder instance

limit

public ListSecretsRequest.Builder limit(Integer limit)

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

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListSecretsRequest.Builder page(String page)

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

Parameters:

page - the value to set

Returns:

this builder instance

opcRequestId

public ListSecretsRequest.Builder opcRequestId(String opcRequestId)

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.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

sortBy

public ListSecretsRequest.Builder sortBy(ListSecretsRequest.SortBy sortBy)

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListSecretsRequest.Builder sortOrder(ListSecretsRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

vaultId

public ListSecretsRequest.Builder vaultId(String vaultId)

The OCID of the vault.

Parameters:

vaultId - the value to set

Returns:

this builder instance

lifecycleState

public ListSecretsRequest.Builder lifecycleState(SecretSummary.LifecycleState lifecycleState)

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

The state value is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

invocationCallback

public ListSecretsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListSecretsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListSecretsRequest.Builder copy(ListSecretsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListSecretsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSecretsRequest build()

Build the instance of ListSecretsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListSecretsRequest,Void>

Returns:

instance of ListSecretsRequest

buildWithoutInvocationCallback

public ListSecretsRequest buildWithoutInvocationCallback()

Build the instance of ListSecretsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListSecretsRequest