com.oracle.bmc.databasemanagement.requests

Class SummarizeAwrDbMetricsRequest.Builder

java.lang.Object

com.oracle.bmc.databasemanagement.requests.SummarizeAwrDbMetricsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<SummarizeAwrDbMetricsRequest,Void>

Enclosing class:

SummarizeAwrDbMetricsRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SummarizeAwrDbMetricsRequest.Builder	awrDbId(String awrDbId) The parameter to filter the database by internal ID.
SummarizeAwrDbMetricsRequest.Builder	beginSnIdGreaterThanOrEqualTo(Integer beginSnIdGreaterThanOrEqualTo) The optional greater than or equal to filter on the snapshot ID.
SummarizeAwrDbMetricsRequest	build() Build the instance of SummarizeAwrDbMetricsRequest as configured by this builder
SummarizeAwrDbMetricsRequest	buildWithoutInvocationCallback() Build the instance of SummarizeAwrDbMetricsRequest as configured by this builder
SummarizeAwrDbMetricsRequest.Builder	containerId(Integer containerId) The optional query parameter to filter the database container by an exact ID value.
SummarizeAwrDbMetricsRequest.Builder	copy(SummarizeAwrDbMetricsRequest o) Copy method to populate the builder with values from the given instance.
SummarizeAwrDbMetricsRequest.Builder	endSnIdLessThanOrEqualTo(Integer endSnIdLessThanOrEqualTo) The optional less than or equal to query parameter to filter the snapshot ID.
SummarizeAwrDbMetricsRequest.Builder	instNum(String instNum) The optional single value query parameter to filter the database instance number.
SummarizeAwrDbMetricsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
SummarizeAwrDbMetricsRequest.Builder	limit(Integer limit) The maximum number of records returned in large paginated response.
SummarizeAwrDbMetricsRequest.Builder	managedDatabaseId(String managedDatabaseId) The OCID of the Managed Database.
SummarizeAwrDbMetricsRequest.Builder	name(List<String> name) The required multiple value query parameter to filter the entity name.
SummarizeAwrDbMetricsRequest.Builder	name(String singularValue) Singular setter.
SummarizeAwrDbMetricsRequest.Builder	opcNamedCredentialId(String opcNamedCredentialId) The OCID of the Named Credential.
SummarizeAwrDbMetricsRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
SummarizeAwrDbMetricsRequest.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.
SummarizeAwrDbMetricsRequest.Builder	page(String page) The page token representing the page from where the next set of paginated results are retrieved.
SummarizeAwrDbMetricsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
SummarizeAwrDbMetricsRequest.Builder	sortBy(SummarizeAwrDbMetricsRequest.SortBy sortBy) The option to sort the AWR time series summary data.
SummarizeAwrDbMetricsRequest.Builder	sortOrder(SortOrders sortOrder) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order.
SummarizeAwrDbMetricsRequest.Builder	timeGreaterThanOrEqualTo(Date timeGreaterThanOrEqualTo) The optional greater than or equal to query parameter to filter the timestamp.
SummarizeAwrDbMetricsRequest.Builder	timeLessThanOrEqualTo(Date timeLessThanOrEqualTo) The optional less than or equal to query parameter to filter the timestamp.

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

managedDatabaseId

public SummarizeAwrDbMetricsRequest.Builder managedDatabaseId(String managedDatabaseId)

The OCID of the Managed Database.

Parameters:

managedDatabaseId - the value to set

Returns:

this builder instance

awrDbId

public SummarizeAwrDbMetricsRequest.Builder awrDbId(String awrDbId)

The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs

Parameters:

awrDbId - the value to set

Returns:

this builder instance

name

public SummarizeAwrDbMetricsRequest.Builder name(List<String> name)

The required multiple value query parameter to filter the entity name.

Parameters:

name - the value to set

Returns:

this builder instance

name

public SummarizeAwrDbMetricsRequest.Builder name(String singularValue)

Singular setter. The required multiple value query parameter to filter the entity name.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

instNum

public SummarizeAwrDbMetricsRequest.Builder instNum(String instNum)

The optional single value query parameter to filter the database instance number.

Parameters:

instNum - the value to set

Returns:

this builder instance

beginSnIdGreaterThanOrEqualTo

public SummarizeAwrDbMetricsRequest.Builder beginSnIdGreaterThanOrEqualTo(Integer beginSnIdGreaterThanOrEqualTo)

The optional greater than or equal to filter on the snapshot ID.

Parameters:

beginSnIdGreaterThanOrEqualTo - the value to set

Returns:

this builder instance

endSnIdLessThanOrEqualTo

public SummarizeAwrDbMetricsRequest.Builder endSnIdLessThanOrEqualTo(Integer endSnIdLessThanOrEqualTo)

The optional less than or equal to query parameter to filter the snapshot ID.

Parameters:

endSnIdLessThanOrEqualTo - the value to set

Returns:

this builder instance

timeGreaterThanOrEqualTo

public SummarizeAwrDbMetricsRequest.Builder timeGreaterThanOrEqualTo(Date timeGreaterThanOrEqualTo)

The optional greater than or equal to query parameter to filter the timestamp.

Parameters:

timeGreaterThanOrEqualTo - the value to set

Returns:

this builder instance

timeLessThanOrEqualTo

public SummarizeAwrDbMetricsRequest.Builder timeLessThanOrEqualTo(Date timeLessThanOrEqualTo)

The optional less than or equal to query parameter to filter the timestamp.

Parameters:

timeLessThanOrEqualTo - the value to set

Returns:

this builder instance

containerId

public SummarizeAwrDbMetricsRequest.Builder containerId(Integer containerId)

The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges

Parameters:

containerId - the value to set

Returns:

this builder instance

page

public SummarizeAwrDbMetricsRequest.Builder page(String page)

The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

limit

public SummarizeAwrDbMetricsRequest.Builder limit(Integer limit)

The maximum number of records returned in large paginated response.

Parameters:

limit - the value to set

Returns:

this builder instance

sortBy

public SummarizeAwrDbMetricsRequest.Builder sortBy(SummarizeAwrDbMetricsRequest.SortBy sortBy)

The option to sort the AWR time series summary data.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public SummarizeAwrDbMetricsRequest.Builder sortOrder(SortOrders sortOrder)

The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

opcRequestId

public SummarizeAwrDbMetricsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

opcRetryToken

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

opcNamedCredentialId

public SummarizeAwrDbMetricsRequest.Builder opcNamedCredentialId(String opcNamedCredentialId)

The OCID of the Named Credential.

Parameters:

opcNamedCredentialId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<SummarizeAwrDbMetricsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public SummarizeAwrDbMetricsRequest build()

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

Returns:

instance of SummarizeAwrDbMetricsRequest

buildWithoutInvocationCallback

public SummarizeAwrDbMetricsRequest buildWithoutInvocationCallback()

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