Package com.oracle.bmc.monitoring.requests

Class ListMetricsRequest.Builder

java.lang.Object

com.oracle.bmc.monitoring.requests.ListMetricsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListMetricsRequest,ListMetricsDetails>

Enclosing class:

ListMetricsRequest

public static class ListMetricsRequest.Builder
extends Object
implements BmcRequest.Builder<ListMetricsRequest,ListMetricsDetails>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListMetricsRequest.Builder	body$(ListMetricsDetails body)	Alternative setter for the body parameter.
ListMetricsRequest	build()	Build the instance of ListMetricsRequest as configured by this builder
ListMetricsRequest	buildWithoutInvocationCallback()	Build the instance of ListMetricsRequest as configured by this builder
ListMetricsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment containing the resources monitored by the metric that you are searching for.
ListMetricsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	When true, returns resources from all compartments and subcompartments.
ListMetricsRequest.Builder	copy(ListMetricsRequest o)	Copy method to populate the builder with values from the given instance.
ListMetricsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListMetricsRequest.Builder	limit(Integer limit)	For list pagination.
ListMetricsRequest.Builder	listMetricsDetails(ListMetricsDetails listMetricsDetails)	The dimensions used to filter metrics.
ListMetricsRequest.Builder	opcRequestId(String opcRequestId)	Customer part of the request identifier token.
ListMetricsRequest.Builder	page(String page)	For list pagination.
ListMetricsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.

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

compartmentId

public ListMetricsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment containing the resources monitored by the metric that you are searching for.

Use tenancyId to search in the root compartment.

Example: ocid1.compartment.oc1..exampleuniqueID

Parameters:

compartmentId - the value to set

Returns:

this builder instance

listMetricsDetails

public ListMetricsRequest.Builder listMetricsDetails(ListMetricsDetails listMetricsDetails)

The dimensions used to filter metrics.

Parameters:

listMetricsDetails - the value to set

Returns:

this builder instance

opcRequestId

public ListMetricsRequest.Builder opcRequestId(String opcRequestId)

Customer part of the request identifier token.

If you need to contact Oracle about a particular request, please provide the complete request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

page

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

limit

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

Default: 1000

Example: 500

Parameters:

limit - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListMetricsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

When true, returns resources from all compartments and subcompartments.

The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListMetricsRequest,ListMetricsDetails>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListMetricsRequest build()

Build the instance of ListMetricsRequest 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<ListMetricsRequest,ListMetricsDetails>

Returns:

instance of ListMetricsRequest

body$

public ListMetricsRequest.Builder body$(ListMetricsDetails body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<ListMetricsRequest,ListMetricsDetails>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public ListMetricsRequest buildWithoutInvocationCallback()

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