com.oracle.bmc.stackmonitoring.requests

Class SearchAssociatedResourcesRequest.Builder

java.lang.Object

com.oracle.bmc.stackmonitoring.requests.SearchAssociatedResourcesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<SearchAssociatedResourcesRequest,SearchAssociatedResourcesDetails>

Enclosing class:

SearchAssociatedResourcesRequest

public static class SearchAssociatedResourcesRequest.Builder
extends Object
implements BmcRequest.Builder<SearchAssociatedResourcesRequest,SearchAssociatedResourcesDetails>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SearchAssociatedResourcesRequest.Builder	body$(SearchAssociatedResourcesDetails body) Alternative setter for the body parameter.
SearchAssociatedResourcesRequest	build() Build the instance of SearchAssociatedResourcesRequest as configured by this builder
SearchAssociatedResourcesRequest	buildWithoutInvocationCallback() Build the instance of SearchAssociatedResourcesRequest as configured by this builder
SearchAssociatedResourcesRequest.Builder	copy(SearchAssociatedResourcesRequest o) Copy method to populate the builder with values from the given instance.
SearchAssociatedResourcesRequest.Builder	excludeFields(List<String> excludeFields) Partial response refers to an optimization technique offered by the RESTful web APIs, to return all the information except the fields requested to be excluded (excludeFields) by the client.
SearchAssociatedResourcesRequest.Builder	excludeFields(String singularValue) Singular setter.
SearchAssociatedResourcesRequest.Builder	fields(List<String> fields) Partial response refers to an optimization technique offered by the RESTful web APIs, to return only the information (fields) required by the client.
SearchAssociatedResourcesRequest.Builder	fields(String singularValue) Singular setter.
SearchAssociatedResourcesRequest.Builder	ifMatch(String ifMatch) For optimistic concurrency control.
SearchAssociatedResourcesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
SearchAssociatedResourcesRequest.Builder	limit(Integer limit) For list pagination.
SearchAssociatedResourcesRequest.Builder	opcRequestId(String opcRequestId) Unique Oracle-assigned identifier for the request.
SearchAssociatedResourcesRequest.Builder	opcRetryToken(String opcRetryToken) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.
SearchAssociatedResourcesRequest.Builder	page(String page) For list pagination.
SearchAssociatedResourcesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
SearchAssociatedResourcesRequest.Builder	searchAssociatedResourcesDetails(SearchAssociatedResourcesDetails searchAssociatedResourcesDetails) Search Criteria for the listing the monitored resources for given type and compartmentId.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

searchAssociatedResourcesDetails

public SearchAssociatedResourcesRequest.Builder searchAssociatedResourcesDetails(SearchAssociatedResourcesDetails searchAssociatedResourcesDetails)

Search Criteria for the listing the monitored resources for given type and compartmentId.

Parameters:

searchAssociatedResourcesDetails - the value to set

Returns:

this builder instance

fields

public SearchAssociatedResourcesRequest.Builder fields(List<String> fields)

Partial response refers to an optimization technique offered by the RESTful web APIs, to return only the information (fields) required by the client. In this mechanism, the client sends the required field names as the query parameters for an API to the server, and the server trims down the default response content by removing the fields that are not required by the client. The parameter controls which fields to return and should be a query string parameter called “fields” of an array type, provide the values as enums, and use collectionFormat.

Parameters:

fields - the value to set

Returns:

this builder instance

fields

public SearchAssociatedResourcesRequest.Builder fields(String singularValue)

Singular setter. Partial response refers to an optimization technique offered by the RESTful web APIs, to return only the information (fields) required by the client. In this mechanism, the client sends the required field names as the query parameters for an API to the server, and the server trims down the default response content by removing the fields that are not required by the client. The parameter controls which fields to return and should be a query string parameter called “fields” of an array type, provide the values as enums, and use collectionFormat.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

excludeFields

public SearchAssociatedResourcesRequest.Builder excludeFields(List<String> excludeFields)

Partial response refers to an optimization technique offered by the RESTful web APIs, to return all the information except the fields requested to be excluded (excludeFields) by the client. In this mechanism, the client sends the exclude field names as the query parameters for an API to the server, and the server trims down the default response content by removing the fields that are not required by the client. The parameter controls which fields to exlude and to return and should be a query string parameter called “excludeFields” of an array type, provide the values as enums, and use collectionFormat.

Parameters:

excludeFields - the value to set

Returns:

this builder instance

excludeFields

public SearchAssociatedResourcesRequest.Builder excludeFields(String singularValue)

Singular setter. Partial response refers to an optimization technique offered by the RESTful web APIs, to return all the information except the fields requested to be excluded (excludeFields) by the client. In this mechanism, the client sends the exclude field names as the query parameters for an API to the server, and the server trims down the default response content by removing the fields that are not required by the client. The parameter controls which fields to exlude and to return and should be a query string parameter called “excludeFields” of an array type, provide the values as enums, and use collectionFormat.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

opcRequestId

public SearchAssociatedResourcesRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

opcRetryToken

public SearchAssociatedResourcesRequest.Builder opcRetryToken(String opcRetryToken)

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Parameters:

opcRetryToken - the value to set

Returns:

this builder instance

ifMatch

public SearchAssociatedResourcesRequest.Builder ifMatch(String ifMatch)

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.

Parameters:

ifMatch - the value to set

Returns:

this builder instance

limit

public SearchAssociatedResourcesRequest.Builder limit(Integer limit)

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

Parameters:

limit - the value to set

Returns:

this builder instance

page

public SearchAssociatedResourcesRequest.Builder page(String page)

For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<SearchAssociatedResourcesRequest,SearchAssociatedResourcesDetails>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public SearchAssociatedResourcesRequest build()

Build the instance of SearchAssociatedResourcesRequest 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<SearchAssociatedResourcesRequest,SearchAssociatedResourcesDetails>

Returns:

instance of SearchAssociatedResourcesRequest

body$

public SearchAssociatedResourcesRequest.Builder body$(SearchAssociatedResourcesDetails body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<SearchAssociatedResourcesRequest,SearchAssociatedResourcesDetails>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public SearchAssociatedResourcesRequest buildWithoutInvocationCallback()

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