com.oracle.bmc.databasemanagement.requests

Class GetAwrDbSqlReportRequest.Builder

java.lang.Object

com.oracle.bmc.databasemanagement.requests.GetAwrDbSqlReportRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<GetAwrDbSqlReportRequest,Void>

Enclosing class:

GetAwrDbSqlReportRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GetAwrDbSqlReportRequest.Builder	awrDbId(String awrDbId) The parameter to filter the database by internal ID.
GetAwrDbSqlReportRequest.Builder	beginSnIdGreaterThanOrEqualTo(Integer beginSnIdGreaterThanOrEqualTo) The optional greater than or equal to filter on the snapshot ID.
GetAwrDbSqlReportRequest	build() Build the instance of GetAwrDbSqlReportRequest as configured by this builder
GetAwrDbSqlReportRequest	buildWithoutInvocationCallback() Build the instance of GetAwrDbSqlReportRequest as configured by this builder
GetAwrDbSqlReportRequest.Builder	containerId(Integer containerId) The optional query parameter to filter the database container by an exact ID value.
GetAwrDbSqlReportRequest.Builder	copy(GetAwrDbSqlReportRequest o) Copy method to populate the builder with values from the given instance.
GetAwrDbSqlReportRequest.Builder	endSnIdLessThanOrEqualTo(Integer endSnIdLessThanOrEqualTo) The optional less than or equal to query parameter to filter the snapshot ID.
GetAwrDbSqlReportRequest.Builder	instNum(String instNum) The optional single value query parameter to filter the database instance number.
GetAwrDbSqlReportRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
GetAwrDbSqlReportRequest.Builder	managedDatabaseId(String managedDatabaseId) The OCID of the Managed Database.
GetAwrDbSqlReportRequest.Builder	opcNamedCredentialId(String opcNamedCredentialId) The OCID of the Named Credential.
GetAwrDbSqlReportRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
GetAwrDbSqlReportRequest.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.
GetAwrDbSqlReportRequest.Builder	reportFormat(GetAwrDbSqlReportRequest.ReportFormat reportFormat) The format of the AWR report.
GetAwrDbSqlReportRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
GetAwrDbSqlReportRequest.Builder	sqlId(String sqlId) The parameter to filter SQL by ID.
GetAwrDbSqlReportRequest.Builder	timeGreaterThanOrEqualTo(Date timeGreaterThanOrEqualTo) The optional greater than or equal to query parameter to filter the timestamp.
GetAwrDbSqlReportRequest.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 GetAwrDbSqlReportRequest.Builder managedDatabaseId(String managedDatabaseId)

The OCID of the Managed Database.

Parameters:

managedDatabaseId - the value to set

Returns:

this builder instance

awrDbId

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

sqlId

public GetAwrDbSqlReportRequest.Builder sqlId(String sqlId)

The parameter to filter SQL by ID. Note that the SQL ID is generated internally by Oracle for each SQL statement and can be retrieved from AWR Report API (/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbReport) or Performance Hub API (/internal/managedDatabases/{managedDatabaseId}/actions/retrievePerformanceData)

Parameters:

sqlId - the value to set

Returns:

this builder instance

instNum

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

reportFormat

public GetAwrDbSqlReportRequest.Builder reportFormat(GetAwrDbSqlReportRequest.ReportFormat reportFormat)

The format of the AWR report.

Parameters:

reportFormat - the value to set

Returns:

this builder instance

containerId

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

opcRequestId

public GetAwrDbSqlReportRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

opcRetryToken

public GetAwrDbSqlReportRequest.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 GetAwrDbSqlReportRequest.Builder opcNamedCredentialId(String opcNamedCredentialId)

The OCID of the Named Credential.

Parameters:

opcNamedCredentialId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<GetAwrDbSqlReportRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public GetAwrDbSqlReportRequest build()

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

Returns:

instance of GetAwrDbSqlReportRequest

buildWithoutInvocationCallback

public GetAwrDbSqlReportRequest buildWithoutInvocationCallback()

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