Package com.oracle.bmc.fleetappsmanagement.requests

Class ListPlatformConfigurationsRequest.Builder

java.lang.Object

com.oracle.bmc.fleetappsmanagement.requests.ListPlatformConfigurationsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListPlatformConfigurationsRequest,Void>

Enclosing class:

ListPlatformConfigurationsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListPlatformConfigurationsRequest	build()	Build the instance of ListPlatformConfigurationsRequest as configured by this builder
ListPlatformConfigurationsRequest	buildWithoutInvocationCallback()	Build the instance of ListPlatformConfigurationsRequest as configured by this builder
ListPlatformConfigurationsRequest.Builder	compartmentId(String compartmentId)	The ID of the compartment in which to list resources.
ListPlatformConfigurationsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	If set to true, resources will be returned for not only the provided compartment, but all compartments which descend from it.
ListPlatformConfigurationsRequest.Builder	configCategory(ConfigCategoryDetails.ConfigCategory configCategory)	Config Category
ListPlatformConfigurationsRequest.Builder	copy(ListPlatformConfigurationsRequest o)	Copy method to populate the builder with values from the given instance.
ListPlatformConfigurationsRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
ListPlatformConfigurationsRequest.Builder	id(String id)	Unique identifier or OCID for listing a single Platform Configuration by id.
ListPlatformConfigurationsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListPlatformConfigurationsRequest.Builder	lifecycleState(PlatformConfiguration.LifecycleState lifecycleState)	A filter to return only resources their lifecycleState matches the given lifecycleState.
ListPlatformConfigurationsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListPlatformConfigurationsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListPlatformConfigurationsRequest.Builder	page(String page)	A token representing the position at which to start retrieving results.
ListPlatformConfigurationsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListPlatformConfigurationsRequest.Builder	sortBy(PlatformConfigurationSortBy sortBy)	The field to sort by.
ListPlatformConfigurationsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘ASC’ or ‘DESC’.
ListPlatformConfigurationsRequest.Builder	type(PlatformConfiguration.Type type)	A filter to return Platform Configurations whose type matches the given type.

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

The ID of the compartment in which to list resources.

Empty only if the resource OCID query param is not specified.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListPlatformConfigurationsRequest.Builder lifecycleState(PlatformConfiguration.LifecycleState lifecycleState)

A filter to return only resources their lifecycleState matches the given lifecycleState.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

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

id

public ListPlatformConfigurationsRequest.Builder id(String id)

Unique identifier or OCID for listing a single Platform Configuration by id.

Either compartmentId or id must be provided.

Parameters:

id - the value to set

Returns:

this builder instance

configCategory

public ListPlatformConfigurationsRequest.Builder configCategory(ConfigCategoryDetails.ConfigCategory configCategory)

Config Category

Parameters:

configCategory - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListPlatformConfigurationsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

If set to true, resources will be returned for not only the provided compartment, but all compartments which descend from it.

Which resources are returned and their field contents depends on the value of accessLevel.

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

type

public ListPlatformConfigurationsRequest.Builder type(PlatformConfiguration.Type type)

A filter to return Platform Configurations whose type matches the given type.

Parameters:

type - the value to set

Returns:

this builder instance

limit

public ListPlatformConfigurationsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListPlatformConfigurationsRequest.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 ListPlatformConfigurationsRequest.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 ListPlatformConfigurationsRequest.Builder sortBy(PlatformConfigurationSortBy 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 ListPlatformConfigurationsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListPlatformConfigurationsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListPlatformConfigurationsRequest build()

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

Returns:

instance of ListPlatformConfigurationsRequest

buildWithoutInvocationCallback

public ListPlatformConfigurationsRequest buildWithoutInvocationCallback()

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