Package com.oracle.bmc.fleetappsmanagement.requests

Class ListPropertiesRequest.Builder

java.lang.Object

com.oracle.bmc.fleetappsmanagement.requests.ListPropertiesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListPropertiesRequest,Void>

Enclosing class:

ListPropertiesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListPropertiesRequest	build()	Build the instance of ListPropertiesRequest as configured by this builder
ListPropertiesRequest	buildWithoutInvocationCallback()	Build the instance of ListPropertiesRequest as configured by this builder
ListPropertiesRequest.Builder	compartmentId(String compartmentId)	The ID of the compartment in which to list resources.
ListPropertiesRequest.Builder	copy(ListPropertiesRequest o)	Copy method to populate the builder with values from the given instance.
ListPropertiesRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
ListPropertiesRequest.Builder	id(String id)	Unique identifier or OCID for listing a single Property by id.
ListPropertiesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListPropertiesRequest.Builder	lifecycleState(Property.LifecycleState lifecycleState)	A filter to return only resources whose lifecycleState matches the given lifecycleState.
ListPropertiesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListPropertiesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListPropertiesRequest.Builder	page(String page)	A token representing the position at which to start retrieving results.
ListPropertiesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListPropertiesRequest.Builder	scope(Scope scope)	A filter to return only resources their scope matches the given scope.
ListPropertiesRequest.Builder	sortBy(PropertySortBy sortBy)	The field to sort by.
ListPropertiesRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘ASC’ or ‘DESC’.
ListPropertiesRequest.Builder	type(Property.Type type)	A filter to return properties 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 ListPropertiesRequest.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 ListPropertiesRequest.Builder lifecycleState(Property.LifecycleState lifecycleState)

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

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListPropertiesRequest.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 ListPropertiesRequest.Builder id(String id)

Unique identifier or OCID for listing a single Property by id.

Either compartmentId or id must be provided.

Parameters:

id - the value to set

Returns:

this builder instance

type

public ListPropertiesRequest.Builder type(Property.Type type)

A filter to return properties whose type matches the given type.

Parameters:

type - the value to set

Returns:

this builder instance

scope

public ListPropertiesRequest.Builder scope(Scope scope)

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

Parameters:

scope - the value to set

Returns:

this builder instance

limit

public ListPropertiesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

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

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListPropertiesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListPropertiesRequest build()

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

Returns:

instance of ListPropertiesRequest

buildWithoutInvocationCallback

public ListPropertiesRequest buildWithoutInvocationCallback()

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