Package com.oracle.bmc.certificatesmanagement.requests

Class ListCertificatesRequest.Builder

java.lang.Object

com.oracle.bmc.certificatesmanagement.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>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListCertificatesRequest	build()	Build the instance of ListCertificatesRequest as configured by this builder
ListCertificatesRequest	buildWithoutInvocationCallback()	Build the instance of ListCertificatesRequest as configured by this builder
ListCertificatesRequest.Builder	certificateId(String certificateId)	The OCID of the certificate.
ListCertificatesRequest.Builder	compartmentId(String compartmentId)	A filter that returns only resources that match the given compartment OCID.
ListCertificatesRequest.Builder	copy(ListCertificatesRequest o)	Copy method to populate the builder with values from the given instance.
ListCertificatesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListCertificatesRequest.Builder	issuerCertificateAuthorityId(String issuerCertificateAuthorityId)	The OCID of the certificate authority (CA).
ListCertificatesRequest.Builder	lifecycleState(ListCertificatesRequest.LifecycleState lifecycleState)	A filter that returns only resources that match the given lifecycle state.
ListCertificatesRequest.Builder	limit(Integer limit)	The maximum number of items to return in a paginated “List” call.
ListCertificatesRequest.Builder	name(String name)	A filter that returns only resources that match the specified name.
ListCertificatesRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListCertificatesRequest.Builder	page(String page)	The value of the opc-next-page response header from the previous “List” call.
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 ascending (ASC) or descending (DESC).

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

opcRequestId

public ListCertificatesRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned 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

compartmentId

public ListCertificatesRequest.Builder compartmentId(String compartmentId)

A filter that returns only resources that match the given compartment OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListCertificatesRequest.Builder lifecycleState(ListCertificatesRequest.LifecycleState lifecycleState)

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

The state value is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

name

public ListCertificatesRequest.Builder name(String name)

A filter that returns only resources that match the specified name.

Parameters:

name - the value to set

Returns:

this builder instance

sortBy

public ListCertificatesRequest.Builder sortBy(ListCertificatesRequest.SortBy sortBy)

The field to sort by.

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

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListCertificatesRequest.Builder sortOrder(ListCertificatesRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

public ListCertificatesRequest.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 ListCertificatesRequest.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

issuerCertificateAuthorityId

public ListCertificatesRequest.Builder issuerCertificateAuthorityId(String issuerCertificateAuthorityId)

The OCID of the certificate authority (CA).

If the parameter is set to null, the service lists all CAs.

Parameters:

issuerCertificateAuthorityId - the value to set

Returns:

this builder instance

certificateId

public ListCertificatesRequest.Builder certificateId(String certificateId)

The OCID of the certificate.

If the parameter is set to null, the service lists all certificates.

Parameters:

certificateId - the value to set

Returns:

this builder instance

invocationCallback

public ListCertificatesRequest.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 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.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<ListCertificatesRequest,Void>

Returns:

instance of ListCertificatesRequest

buildWithoutInvocationCallback

public ListCertificatesRequest buildWithoutInvocationCallback()

Build the instance of ListCertificatesRequest 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 ListCertificatesRequest