com.oracle.bmc.computecloudatcustomer.requests

Class ListCccInfrastructuresRequest.Builder

java.lang.Object

com.oracle.bmc.computecloudatcustomer.requests.ListCccInfrastructuresRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListCccInfrastructuresRequest,Void>

Enclosing class:

ListCccInfrastructuresRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListCccInfrastructuresRequest.Builder	accessLevel(ListCccInfrastructuresRequest.AccessLevel accessLevel) Valid values are RESTRICTED and ACCESSIBLE.
ListCccInfrastructuresRequest	build() Build the instance of ListCccInfrastructuresRequest as configured by this builder
ListCccInfrastructuresRequest	buildWithoutInvocationCallback() Build the instance of ListCccInfrastructuresRequest as configured by this builder
ListCccInfrastructuresRequest.Builder	cccInfrastructureId(String cccInfrastructureId) An OCID for a Compute Cloud@Customer Infrastructure.
ListCccInfrastructuresRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment in which to list resources.
ListCccInfrastructuresRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree) Default is false.
ListCccInfrastructuresRequest.Builder	copy(ListCccInfrastructuresRequest o) Copy method to populate the builder with values from the given instance.
ListCccInfrastructuresRequest.Builder	displayName(String displayName) A filter to return only resources that match the entire display name given.
ListCccInfrastructuresRequest.Builder	displayNameContains(String displayNameContains) A filter to return only resources whose display name contains the substring.
ListCccInfrastructuresRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListCccInfrastructuresRequest.Builder	lifecycleState(CccInfrastructure.LifecycleState lifecycleState) A filter used to return only resources that match the given lifecycleState.
ListCccInfrastructuresRequest.Builder	limit(Integer limit) The maximum number of items to return.
ListCccInfrastructuresRequest.Builder	opcRequestId(String opcRequestId) The client request OCID for tracing.
ListCccInfrastructuresRequest.Builder	page(String page) A token representing the position at which to start retrieving results.
ListCccInfrastructuresRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListCccInfrastructuresRequest.Builder	sortBy(ListCccInfrastructuresRequest.SortBy sortBy) The field to sort by.
ListCccInfrastructuresRequest.Builder	sortOrder(SortOrder sortOrder) The sort order to use, either ‘ASC’ or ‘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

compartmentId

public ListCccInfrastructuresRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListCccInfrastructuresRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

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

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

accessLevel

public ListCccInfrastructuresRequest.Builder accessLevel(ListCccInfrastructuresRequest.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

lifecycleState

public ListCccInfrastructuresRequest.Builder lifecycleState(CccInfrastructure.LifecycleState lifecycleState)

A filter used to return only resources that match the given lifecycleState.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListCccInfrastructuresRequest.Builder displayName(String displayName)

A filter to return only resources that match the entire display name given.

Parameters:

displayName - the value to set

Returns:

this builder instance

displayNameContains

public ListCccInfrastructuresRequest.Builder displayNameContains(String displayNameContains)

A filter to return only resources whose display name contains the substring.

Parameters:

displayNameContains - the value to set

Returns:

this builder instance

cccInfrastructureId

public ListCccInfrastructuresRequest.Builder cccInfrastructureId(String cccInfrastructureId)

An OCID for a Compute Cloud@Customer Infrastructure.

Parameters:

cccInfrastructureId - the value to set

Returns:

this builder instance

limit

public ListCccInfrastructuresRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListCccInfrastructuresRequest.Builder page(String page)

A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListCccInfrastructuresRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use, either ‘ASC’ or ‘DESC’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListCccInfrastructuresRequest.Builder sortBy(ListCccInfrastructuresRequest.SortBy sortBy)

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListCccInfrastructuresRequest.Builder opcRequestId(String opcRequestId)

The client request OCID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListCccInfrastructuresRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListCccInfrastructuresRequest build()

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

Returns:

instance of ListCccInfrastructuresRequest

buildWithoutInvocationCallback

public ListCccInfrastructuresRequest buildWithoutInvocationCallback()

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