Package com.oracle.bmc.opsi.requests

Class SummarizeDatabaseInsightResourceStatisticsRequest.Builder

java.lang.Object

com.oracle.bmc.opsi.requests.SummarizeDatabaseInsightResourceStatisticsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<SummarizeDatabaseInsightResourceStatisticsRequest,Void>

Enclosing class:

SummarizeDatabaseInsightResourceStatisticsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	analysisTimeInterval(String analysisTimeInterval)	Specify time period in ISO 8601 format with respect to current time.
SummarizeDatabaseInsightResourceStatisticsRequest	build()	Build the instance of SummarizeDatabaseInsightResourceStatisticsRequest as configured by this builder
SummarizeDatabaseInsightResourceStatisticsRequest	buildWithoutInvocationCallback()	Build the instance of SummarizeDatabaseInsightResourceStatisticsRequest as configured by this builder
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	cdbName(String singularValue)	Singular setter.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	cdbName(List<String> cdbName)	Filter by one or more cdb name.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	A flag to search all resources within a given compartment and all sub-compartments.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	copy(SummarizeDatabaseInsightResourceStatisticsRequest o)	Copy method to populate the builder with values from the given instance.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	databaseId(String singularValue)	Singular setter.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	databaseId(List<String> databaseId)	Optional list of database OCIDs of the associated DBaaS entity.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	databaseType(SummarizeDatabaseInsightResourceStatisticsRequest.DatabaseType singularValue)	Singular setter.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	databaseType(List<SummarizeDatabaseInsightResourceStatisticsRequest.DatabaseType> databaseType)	Filter by one or more database type.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	definedTagEquals(String singularValue)	Singular setter.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	definedTagEquals(List<String> definedTagEquals)	A list of tag filters to apply.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	definedTagExists(String singularValue)	Singular setter.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	definedTagExists(List<String> definedTagExists)	A list of tag existence filters to apply.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	exadataInsightId(String singularValue)	Singular setter.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	exadataInsightId(List<String> exadataInsightId)	Optional list of exadata insight resource OCIDs.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	forecastDays(Integer forecastDays)	Number of days used for utilization forecast analysis.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	freeformTagEquals(String singularValue)	Singular setter.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	freeformTagEquals(List<String> freeformTagEquals)	A list of tag filters to apply.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	freeformTagExists(String singularValue)	Singular setter.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	freeformTagExists(List<String> freeformTagExists)	A list of tag existence filters to apply.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	highUtilizationThreshold(Integer highUtilizationThreshold)	Percent value in which a resource metric is considered highly utilized.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	hostName(String singularValue)	Singular setter.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	hostName(List<String> hostName)	Filter by one or more hostname.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	id(String singularValue)	Singular setter.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	id(List<String> id)	Optional list of database insight resource OCIDs.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	insightBy(String insightBy)	Return data of a specific insight Possible values are High Utilization, Low Utilization, Any ,High Utilization Forecast, Low Utilization Forecast
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	isDatabaseInstanceLevelMetrics(Boolean isDatabaseInstanceLevelMetrics)	Flag to indicate if database instance level metrics should be returned.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	limit(Integer limit)	For list pagination.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	lowUtilizationThreshold(Integer lowUtilizationThreshold)	Percent value in which a resource metric is considered low utilized.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	page(String page)	For list pagination.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	percentile(Integer percentile)	Percentile values of daily usage to be used for computing the aggregate resource usage.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	resourceMetric(String resourceMetric)	Filter by resource metric.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	sortBy(SummarizeDatabaseInsightResourceStatisticsRequest.SortBy sortBy)	The order in which resource statistics records are listed
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	timeIntervalEnd(Date timeIntervalEnd)	Analysis end time in UTC in ISO 8601 format(exclusive).
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	timeIntervalStart(Date timeIntervalStart)	Analysis start time in UTC in ISO 8601 format(inclusive).
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	vmclusterName(String singularValue)	Singular setter.
SummarizeDatabaseInsightResourceStatisticsRequest.Builder	vmclusterName(List<String> vmclusterName)	Optional list of Exadata Insight VM cluster name.

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

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

resourceMetric

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder resourceMetric(String resourceMetric)

Filter by resource metric.

Supported values are CPU , STORAGE, MEMORY and IO.

Parameters:

resourceMetric - the value to set

Returns:

this builder instance

analysisTimeInterval

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder analysisTimeInterval(String analysisTimeInterval)

Specify time period in ISO 8601 format with respect to current time.

Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).

Parameters:

analysisTimeInterval - the value to set

Returns:

this builder instance

timeIntervalStart

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder timeIntervalStart(Date timeIntervalStart)

Analysis start time in UTC in ISO 8601 format(inclusive).

Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.

Parameters:

timeIntervalStart - the value to set

Returns:

this builder instance

timeIntervalEnd

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder timeIntervalEnd(Date timeIntervalEnd)

Analysis end time in UTC in ISO 8601 format(exclusive).

Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.

Parameters:

timeIntervalEnd - the value to set

Returns:

this builder instance

databaseType

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder databaseType(List<SummarizeDatabaseInsightResourceStatisticsRequest.DatabaseType> databaseType)

Filter by one or more database type.

Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Parameters:

databaseType - the value to set

Returns:

this builder instance

databaseType

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder databaseType(SummarizeDatabaseInsightResourceStatisticsRequest.DatabaseType singularValue)

Singular setter.

Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

databaseId

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder databaseId(List<String> databaseId)

Optional list of database OCIDs of the associated DBaaS entity.

Parameters:

databaseId - the value to set

Returns:

this builder instance

databaseId

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder databaseId(String singularValue)

Singular setter.

Optional list of database OCIDs of the associated DBaaS entity.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

id

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder id(List<String> id)

Optional list of database insight resource OCIDs.

Parameters:

id - the value to set

Returns:

this builder instance

id

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder id(String singularValue)

Singular setter.

Optional list of database insight resource OCIDs.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

exadataInsightId

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder exadataInsightId(List<String> exadataInsightId)

Optional list of exadata insight resource OCIDs.

Parameters:

exadataInsightId - the value to set

Returns:

this builder instance

exadataInsightId

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder exadataInsightId(String singularValue)

Singular setter.

Optional list of exadata insight resource OCIDs.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

cdbName

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder cdbName(List<String> cdbName)

Filter by one or more cdb name.

Parameters:

cdbName - the value to set

Returns:

this builder instance

cdbName

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder cdbName(String singularValue)

Singular setter.

Filter by one or more cdb name.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

percentile

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder percentile(Integer percentile)

Percentile values of daily usage to be used for computing the aggregate resource usage.

Parameters:

percentile - the value to set

Returns:

this builder instance

insightBy

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder insightBy(String insightBy)

Return data of a specific insight Possible values are High Utilization, Low Utilization, Any ,High Utilization Forecast, Low Utilization Forecast

Parameters:

insightBy - the value to set

Returns:

this builder instance

forecastDays

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder forecastDays(Integer forecastDays)

Number of days used for utilization forecast analysis.

Parameters:

forecastDays - the value to set

Returns:

this builder instance

limit

public SummarizeDatabaseInsightResourceStatisticsRequest.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. Example: 50

Parameters:

limit - the value to set

Returns:

this builder instance

page

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

sortOrder

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

sortBy

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder sortBy(SummarizeDatabaseInsightResourceStatisticsRequest.SortBy sortBy)

The order in which resource statistics records are listed

Parameters:

sortBy - the value to set

Returns:

this builder instance

hostName

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder hostName(List<String> hostName)

Filter by one or more hostname.

Parameters:

hostName - the value to set

Returns:

this builder instance

hostName

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder hostName(String singularValue)

Singular setter.

Filter by one or more hostname.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

isDatabaseInstanceLevelMetrics

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder isDatabaseInstanceLevelMetrics(Boolean isDatabaseInstanceLevelMetrics)

Flag to indicate if database instance level metrics should be returned.

The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host.

Parameters:

isDatabaseInstanceLevelMetrics - the value to set

Returns:

this builder instance

opcRequestId

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

definedTagEquals

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder definedTagEquals(List<String> definedTagEquals)

A list of tag filters to apply.

Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”.

Parameters:

definedTagEquals - the value to set

Returns:

this builder instance

definedTagEquals

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder definedTagEquals(String singularValue)

Singular setter.

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

freeformTagEquals

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder freeformTagEquals(List<String> freeformTagEquals)

A list of tag filters to apply.

Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”.

Parameters:

freeformTagEquals - the value to set

Returns:

this builder instance

freeformTagEquals

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder freeformTagEquals(String singularValue)

Singular setter.

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

definedTagExists

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder definedTagExists(List<String> definedTagExists)

A list of tag existence filters to apply.

Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”.

Parameters:

definedTagExists - the value to set

Returns:

this builder instance

definedTagExists

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder definedTagExists(String singularValue)

Singular setter.

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

freeformTagExists

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder freeformTagExists(List<String> freeformTagExists)

A list of tag existence filters to apply.

Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”.

Parameters:

freeformTagExists - the value to set

Returns:

this builder instance

freeformTagExists

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder freeformTagExists(String singularValue)

Singular setter.

A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

compartmentIdInSubtree

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

A flag to search all resources within a given compartment and all sub-compartments.

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

vmclusterName

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder vmclusterName(List<String> vmclusterName)

Optional list of Exadata Insight VM cluster name.

Parameters:

vmclusterName - the value to set

Returns:

this builder instance

vmclusterName

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder vmclusterName(String singularValue)

Singular setter.

Optional list of Exadata Insight VM cluster name.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

highUtilizationThreshold

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder highUtilizationThreshold(Integer highUtilizationThreshold)

Percent value in which a resource metric is considered highly utilized.

Parameters:

highUtilizationThreshold - the value to set

Returns:

this builder instance

lowUtilizationThreshold

public SummarizeDatabaseInsightResourceStatisticsRequest.Builder lowUtilizationThreshold(Integer lowUtilizationThreshold)

Percent value in which a resource metric is considered low utilized.

Parameters:

lowUtilizationThreshold - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<SummarizeDatabaseInsightResourceStatisticsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public SummarizeDatabaseInsightResourceStatisticsRequest build()

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

Returns:

instance of SummarizeDatabaseInsightResourceStatisticsRequest

buildWithoutInvocationCallback

public SummarizeDatabaseInsightResourceStatisticsRequest buildWithoutInvocationCallback()

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