com.oracle.bmc.apigateway.requests

Class ListCertificatesRequest.Builder

java.lang.Object

com.oracle.bmc.apigateway.requests.ListCertificatesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListCertificatesRequest,Void>

Enclosing class:

ListCertificatesRequest

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

Method Summary

Modifier and Type	Method and Description
ListCertificatesRequest	build() Build the instance of ListCertificatesRequest as configured by this builder
ListCertificatesRequest	buildWithoutInvocationCallback()
ListCertificatesRequest.Builder	compartmentId(String compartmentId) The ocid of the compartment in which to list resources.
ListCertificatesRequest.Builder	copy(ListCertificatesRequest o) Copy method to populate the builder with values from the given instance.
ListCertificatesRequest.Builder	displayName(String displayName) A user-friendly name.
ListCertificatesRequest.Builder	invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback) Set the invocation callback for the request to be built.
ListCertificatesRequest.Builder	lifecycleState(Certificate.LifecycleState lifecycleState) A filter to return only resources that match the given lifecycle state.
ListCertificatesRequest.Builder	limit(Integer limit) The maximum number of items to return.
ListCertificatesRequest.Builder	opcRequestId(String opcRequestId) The client request id for tracing.
ListCertificatesRequest.Builder	page(String page) The page token representing the page at which to start retrieving results.
ListCertificatesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListCertificatesRequest.Builder	sortBy(ListCertificatesRequest.SortBy sortBy) The field to sort by.
ListCertificatesRequest.Builder	sortOrder(ListCertificatesRequest.SortOrder sortOrder) The sort order to use, either ‘asc’ or ‘desc’.
String	toString()

Methods inherited from class java.lang.Object

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

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

body$

Method Detail

invocationCallback

public ListCertificatesRequest.Builder invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> 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 ListCertificatesRequest.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 ListCertificatesRequest.Builder copy(ListCertificatesRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListCertificatesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListCertificatesRequest build()

Build the instance of ListCertificatesRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.util.internal.Consumer) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListCertificatesRequest,Void>

Returns:

instance of ListCertificatesRequest

compartmentId

public ListCertificatesRequest.Builder compartmentId(String compartmentId)

The ocid of the compartment in which to list resources.

Returns:

this.

displayName

public ListCertificatesRequest.Builder displayName(String displayName)

A user-friendly name. Does not have to be unique, and it’s changeable.

Example: My new resource

Returns:

this.

lifecycleState

public ListCertificatesRequest.Builder lifecycleState(Certificate.LifecycleState lifecycleState)

A filter to return only resources that match the given lifecycle state.

Example: ACTIVE or DELETED

Returns:

this.

limit

public ListCertificatesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Returns:

this.

page

public ListCertificatesRequest.Builder page(String page)

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

Returns:

this.

sortOrder

public ListCertificatesRequest.Builder sortOrder(ListCertificatesRequest.SortOrder sortOrder)

The sort order to use, either ‘asc’ or ‘desc’. The default order depends on the sortBy value.

Returns:

this.

sortBy

public ListCertificatesRequest.Builder sortBy(ListCertificatesRequest.SortBy sortBy)

The field to sort by. You can provide one sort order (sortOrder). Default order for timeCreated is descending. Default order for displayName is ascending. The displayName sort order is case sensitive.

Returns:

this.

opcRequestId

public ListCertificatesRequest.Builder opcRequestId(String opcRequestId)

The client request id for tracing.

Returns:

this.

buildWithoutInvocationCallback

public ListCertificatesRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object