com.oracle.bmc.stackmonitoring.requests

Class ListMonitoredResourceTypesRequest.Builder

java.lang.Object

com.oracle.bmc.stackmonitoring.requests.ListMonitoredResourceTypesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListMonitoredResourceTypesRequest,Void>

Enclosing class:

ListMonitoredResourceTypesRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListMonitoredResourceTypesRequest	build() Build the instance of ListMonitoredResourceTypesRequest as configured by this builder
ListMonitoredResourceTypesRequest	buildWithoutInvocationCallback() Build the instance of ListMonitoredResourceTypesRequest as configured by this builder
ListMonitoredResourceTypesRequest.Builder	compartmentId(String compartmentId) The OCID of the tenancy for which monitored resource types should be listed.
ListMonitoredResourceTypesRequest.Builder	copy(ListMonitoredResourceTypesRequest o) Copy method to populate the builder with values from the given instance.
ListMonitoredResourceTypesRequest.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.
ListMonitoredResourceTypesRequest.Builder	excludeFields(String singularValue) Singular setter.
ListMonitoredResourceTypesRequest.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.
ListMonitoredResourceTypesRequest.Builder	fields(String singularValue) Singular setter.
ListMonitoredResourceTypesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListMonitoredResourceTypesRequest.Builder	isExcludeSystemTypes(Boolean isExcludeSystemTypes) A filter to exclude system resource types.
ListMonitoredResourceTypesRequest.Builder	limit(Integer limit) For list pagination.
ListMonitoredResourceTypesRequest.Builder	metricNamespace(String metricNamespace) A filter to return monitored resource types that has the matching namespace.
ListMonitoredResourceTypesRequest.Builder	name(String name) A filter to return monitored resource types that match exactly with the resource type name given.
ListMonitoredResourceTypesRequest.Builder	opcRequestId(String opcRequestId) Unique Oracle-assigned identifier for the request.
ListMonitoredResourceTypesRequest.Builder	page(String page) For list pagination.
ListMonitoredResourceTypesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListMonitoredResourceTypesRequest.Builder	sortBy(ListMonitoredResourceTypesRequest.SortBy sortBy) The field to sort by.
ListMonitoredResourceTypesRequest.Builder	sortOrder(SortOrder sortOrder) The sort order to use, either ascending (ASC) or descending (DESC).
ListMonitoredResourceTypesRequest.Builder	status(ResourceTypeLifecycleState status) A filter to return only resources that matches with lifecycleState given.

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

The OCID of the tenancy for which monitored resource types should be listed.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

name

public ListMonitoredResourceTypesRequest.Builder name(String name)

A filter to return monitored resource types that match exactly with the resource type name given.

Parameters:

name - the value to set

Returns:

this builder instance

status

public ListMonitoredResourceTypesRequest.Builder status(ResourceTypeLifecycleState status)

A filter to return only resources that matches with lifecycleState given.

Parameters:

status - the value to set

Returns:

this builder instance

isExcludeSystemTypes

public ListMonitoredResourceTypesRequest.Builder isExcludeSystemTypes(Boolean isExcludeSystemTypes)

A filter to exclude system resource types. If set to true, system resource types will be excluded.

Parameters:

isExcludeSystemTypes - the value to set

Returns:

this builder instance

metricNamespace

public ListMonitoredResourceTypesRequest.Builder metricNamespace(String metricNamespace)

A filter to return monitored resource types that has the matching namespace.

Parameters:

metricNamespace - the value to set

Returns:

this builder instance

sortBy

public ListMonitoredResourceTypesRequest.Builder sortBy(ListMonitoredResourceTypesRequest.SortBy sortBy)

The field to sort by. Only one sort order may be provided. Default order for ‘timeUpdated’ is descending. Default order for ‘name’ is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListMonitoredResourceTypesRequest.Builder sortOrder(SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

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

opcRequestId

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

fields

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

MonitoredResourceType Id, name and compartment will be added by default.

Parameters:

fields - the value to set

Returns:

this builder instance

fields

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

MonitoredResourceType Id, name and compartment will be added by default.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

excludeFields

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

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListMonitoredResourceTypesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListMonitoredResourceTypesRequest build()

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

Returns:

instance of ListMonitoredResourceTypesRequest

buildWithoutInvocationCallback

public ListMonitoredResourceTypesRequest buildWithoutInvocationCallback()

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