Package com.oracle.bmc.datasafe.requests

Class ListCryptoAssessmentKeysRequest.Builder

java.lang.Object

com.oracle.bmc.datasafe.requests.ListCryptoAssessmentKeysRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListCryptoAssessmentKeysRequest,Void>

Enclosing class:

ListCryptoAssessmentKeysRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListCryptoAssessmentKeysRequest.Builder	accessLevel(ListCryptoAssessmentKeysRequest.AccessLevel accessLevel)	Valid values are RESTRICTED and ACCESSIBLE.
ListCryptoAssessmentKeysRequest.Builder	assessmentId(String assessmentId)	A filter to return only resources associated with the specified crypto assessment OCID.
ListCryptoAssessmentKeysRequest.Builder	assessmentType(CryptoAssessment.Type assessmentType)	A filter to return targets from assessments of the specified type.
ListCryptoAssessmentKeysRequest	build()	Build the instance of ListCryptoAssessmentKeysRequest as configured by this builder
ListCryptoAssessmentKeysRequest	buildWithoutInvocationCallback()	Build the instance of ListCryptoAssessmentKeysRequest as configured by this builder
ListCryptoAssessmentKeysRequest.Builder	compartmentId(String compartmentId)	A filter to return only resources that match the specified compartment OCID.
ListCryptoAssessmentKeysRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	Default is false.
ListCryptoAssessmentKeysRequest.Builder	copy(ListCryptoAssessmentKeysRequest o)	Copy method to populate the builder with values from the given instance.
ListCryptoAssessmentKeysRequest.Builder	feature(CryptoFeature feature)	A filter to return only records for the specified feature.
ListCryptoAssessmentKeysRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListCryptoAssessmentKeysRequest.Builder	keyId(String keyId)	Filters key results to rows with an exact matching keyId.
ListCryptoAssessmentKeysRequest.Builder	keyManagerType(CryptoKeystoreType singularValue)	Singular setter.
ListCryptoAssessmentKeysRequest.Builder	keyManagerType(List<CryptoKeystoreType> keyManagerType)	Filters key results to rows whose primary or secondary keystore type matches any of the specified key manager types.
ListCryptoAssessmentKeysRequest.Builder	keyType(CryptoAssessmentKeySummary.KeyType keyType)	Filters key results to rows with the specified key type.
ListCryptoAssessmentKeysRequest.Builder	limit(Integer limit)	For list pagination.
ListCryptoAssessmentKeysRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
ListCryptoAssessmentKeysRequest.Builder	page(String page)	For list pagination.
ListCryptoAssessmentKeysRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListCryptoAssessmentKeysRequest.Builder	sortBy(ListCryptoAssessmentKeysRequest.SortBy sortBy)	The field used to sort key results.
ListCryptoAssessmentKeysRequest.Builder	sortOrder(ListCryptoAssessmentKeysRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListCryptoAssessmentKeysRequest.Builder	targetId(String targetId)	A filter to return only inventory rows associated with the specified target OCID.
ListCryptoAssessmentKeysRequest.Builder	targetIds(String singularValue)	Singular setter.
ListCryptoAssessmentKeysRequest.Builder	targetIds(List<String> targetIds)	A filter to return only resources associated with any of the specified target OCIDs.

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 ListCryptoAssessmentKeysRequest.Builder compartmentId(String compartmentId)

A filter to return only resources that match the specified compartment OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListCryptoAssessmentKeysRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

Default is false.

When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

accessLevel

public ListCryptoAssessmentKeysRequest.Builder accessLevel(ListCryptoAssessmentKeysRequest.AccessLevel accessLevel)

Valid values are RESTRICTED and ACCESSIBLE.

Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

Parameters:

accessLevel - the value to set

Returns:

this builder instance

assessmentId

public ListCryptoAssessmentKeysRequest.Builder assessmentId(String assessmentId)

A filter to return only resources associated with the specified crypto assessment OCID.

Parameters:

assessmentId - the value to set

Returns:

this builder instance

assessmentType

public ListCryptoAssessmentKeysRequest.Builder assessmentType(CryptoAssessment.Type assessmentType)

A filter to return targets from assessments of the specified type.

Parameters:

assessmentType - the value to set

Returns:

this builder instance

targetId

public ListCryptoAssessmentKeysRequest.Builder targetId(String targetId)

A filter to return only inventory rows associated with the specified target OCID.

Parameters:

targetId - the value to set

Returns:

this builder instance

targetIds

public ListCryptoAssessmentKeysRequest.Builder targetIds(List<String> targetIds)

A filter to return only resources associated with any of the specified target OCIDs.

Parameters:

targetIds - the value to set

Returns:

this builder instance

targetIds

public ListCryptoAssessmentKeysRequest.Builder targetIds(String singularValue)

Singular setter.

A filter to return only resources associated with any of the specified target OCIDs.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

feature

public ListCryptoAssessmentKeysRequest.Builder feature(CryptoFeature feature)

A filter to return only records for the specified feature.

Parameters:

feature - the value to set

Returns:

this builder instance

keyId

public ListCryptoAssessmentKeysRequest.Builder keyId(String keyId)

Filters key results to rows with an exact matching keyId.

Parameters:

keyId - the value to set

Returns:

this builder instance

keyType

public ListCryptoAssessmentKeysRequest.Builder keyType(CryptoAssessmentKeySummary.KeyType keyType)

Filters key results to rows with the specified key type.

Parameters:

keyType - the value to set

Returns:

this builder instance

keyManagerType

public ListCryptoAssessmentKeysRequest.Builder keyManagerType(List<CryptoKeystoreType> keyManagerType)

Filters key results to rows whose primary or secondary keystore type matches any of the specified key manager types.

Parameters:

keyManagerType - the value to set

Returns:

this builder instance

keyManagerType

public ListCryptoAssessmentKeysRequest.Builder keyManagerType(CryptoKeystoreType singularValue)

Singular setter.

Filters key results to rows whose primary or secondary keystore type matches any of the specified key manager types.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

sortBy

public ListCryptoAssessmentKeysRequest.Builder sortBy(ListCryptoAssessmentKeysRequest.SortBy sortBy)

The field used to sort key results.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListCryptoAssessmentKeysRequest.Builder sortOrder(ListCryptoAssessmentKeysRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

opcRequestId

public ListCryptoAssessmentKeysRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

limit

public ListCryptoAssessmentKeysRequest.Builder limit(Integer limit)

For list pagination.

The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListCryptoAssessmentKeysRequest.Builder page(String page)

For list pagination.

The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

invocationCallback

public ListCryptoAssessmentKeysRequest.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 ListCryptoAssessmentKeysRequest.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 ListCryptoAssessmentKeysRequest.Builder copy(ListCryptoAssessmentKeysRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListCryptoAssessmentKeysRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListCryptoAssessmentKeysRequest build()

Build the instance of ListCryptoAssessmentKeysRequest 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<ListCryptoAssessmentKeysRequest,Void>

Returns:

instance of ListCryptoAssessmentKeysRequest

buildWithoutInvocationCallback

public ListCryptoAssessmentKeysRequest buildWithoutInvocationCallback()

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