com.oracle.bmc.opsi.requests

Class SummarizeHostInsightResourceUsageRequest.Builder

java.lang.Object

com.oracle.bmc.opsi.requests.SummarizeHostInsightResourceUsageRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<SummarizeHostInsightResourceUsageRequest,Void>

Enclosing class:

SummarizeHostInsightResourceUsageRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SummarizeHostInsightResourceUsageRequest.Builder	analysisTimeInterval(String analysisTimeInterval) Specify time period in ISO 8601 format with respect to current time.
SummarizeHostInsightResourceUsageRequest	build() Build the instance of SummarizeHostInsightResourceUsageRequest as configured by this builder
SummarizeHostInsightResourceUsageRequest	buildWithoutInvocationCallback() Build the instance of SummarizeHostInsightResourceUsageRequest as configured by this builder
SummarizeHostInsightResourceUsageRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment.
SummarizeHostInsightResourceUsageRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree) A flag to search all resources within a given compartment and all sub-compartments.
SummarizeHostInsightResourceUsageRequest.Builder	copy(SummarizeHostInsightResourceUsageRequest o) Copy method to populate the builder with values from the given instance.
SummarizeHostInsightResourceUsageRequest.Builder	definedTagEquals(List<String> definedTagEquals) A list of tag filters to apply.
SummarizeHostInsightResourceUsageRequest.Builder	definedTagEquals(String singularValue) Singular setter.
SummarizeHostInsightResourceUsageRequest.Builder	definedTagExists(List<String> definedTagExists) A list of tag existence filters to apply.
SummarizeHostInsightResourceUsageRequest.Builder	definedTagExists(String singularValue) Singular setter.
SummarizeHostInsightResourceUsageRequest.Builder	exadataInsightId(List<String> exadataInsightId) Optional list of exadata insight resource OCIDs.
SummarizeHostInsightResourceUsageRequest.Builder	exadataInsightId(String singularValue) Singular setter.
SummarizeHostInsightResourceUsageRequest.Builder	freeformTagEquals(List<String> freeformTagEquals) A list of tag filters to apply.
SummarizeHostInsightResourceUsageRequest.Builder	freeformTagEquals(String singularValue) Singular setter.
SummarizeHostInsightResourceUsageRequest.Builder	freeformTagExists(List<String> freeformTagExists) A list of tag existence filters to apply.
SummarizeHostInsightResourceUsageRequest.Builder	freeformTagExists(String singularValue) Singular setter.
SummarizeHostInsightResourceUsageRequest.Builder	hostId(String hostId) Optional OCID of the host (Compute Id)
SummarizeHostInsightResourceUsageRequest.Builder	hostType(List<String> hostType) Filter by one or more host types.
SummarizeHostInsightResourceUsageRequest.Builder	hostType(String singularValue) Singular setter.
SummarizeHostInsightResourceUsageRequest.Builder	id(List<String> id) Optional list of host insight resource OCIDs.
SummarizeHostInsightResourceUsageRequest.Builder	id(String singularValue) Singular setter.
SummarizeHostInsightResourceUsageRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
SummarizeHostInsightResourceUsageRequest.Builder	opcRequestId(String opcRequestId) Unique Oracle-assigned identifier for the request.
SummarizeHostInsightResourceUsageRequest.Builder	page(String page) For list pagination.
SummarizeHostInsightResourceUsageRequest.Builder	percentile(Integer percentile) Percentile values of daily usage to be used for computing the aggregate resource usage.
SummarizeHostInsightResourceUsageRequest.Builder	platformType(List<SummarizeHostInsightResourceUsageRequest.PlatformType> platformType) Filter by one or more platform types.
SummarizeHostInsightResourceUsageRequest.Builder	platformType(SummarizeHostInsightResourceUsageRequest.PlatformType singularValue) Singular setter.
SummarizeHostInsightResourceUsageRequest.Builder	resourceMetric(String resourceMetric) Filter by host resource metric.
SummarizeHostInsightResourceUsageRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
SummarizeHostInsightResourceUsageRequest.Builder	status(List<ResourceStatus> status) Resource Status
SummarizeHostInsightResourceUsageRequest.Builder	status(ResourceStatus singularValue) Singular setter.
SummarizeHostInsightResourceUsageRequest.Builder	timeIntervalEnd(Date timeIntervalEnd) Analysis end time in UTC in ISO 8601 format(exclusive).
SummarizeHostInsightResourceUsageRequest.Builder	timeIntervalStart(Date timeIntervalStart) Analysis start time in UTC in ISO 8601 format(inclusive).
SummarizeHostInsightResourceUsageRequest.Builder	vmclusterName(List<String> vmclusterName) Optional list of Exadata Insight VM cluster name.
SummarizeHostInsightResourceUsageRequest.Builder	vmclusterName(String singularValue) Singular setter.

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

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

resourceMetric

public SummarizeHostInsightResourceUsageRequest.Builder resourceMetric(String resourceMetric)

Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.

Parameters:

resourceMetric - the value to set

Returns:

this builder instance

analysisTimeInterval

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

platformType

public SummarizeHostInsightResourceUsageRequest.Builder platformType(List<SummarizeHostInsightResourceUsageRequest.PlatformType> platformType)

Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX].

Parameters:

platformType - the value to set

Returns:

this builder instance

platformType

public SummarizeHostInsightResourceUsageRequest.Builder platformType(SummarizeHostInsightResourceUsageRequest.PlatformType singularValue)

Singular setter. Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX].

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

id

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

Optional list of host insight resource OCIDs.

Parameters:

id - the value to set

Returns:

this builder instance

id

public SummarizeHostInsightResourceUsageRequest.Builder id(String singularValue)

Singular setter. Optional list of host insight resource OCIDs.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

exadataInsightId

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

Optional list of exadata insight resource OCIDs.

Parameters:

exadataInsightId - the value to set

Returns:

this builder instance

exadataInsightId

public SummarizeHostInsightResourceUsageRequest.Builder exadataInsightId(String singularValue)

Singular setter. Optional list of exadata insight resource OCIDs.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

page

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

percentile

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

opcRequestId

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

hostType

public SummarizeHostInsightResourceUsageRequest.Builder hostType(List<String> hostType)

Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST

Parameters:

hostType - the value to set

Returns:

this builder instance

hostType

public SummarizeHostInsightResourceUsageRequest.Builder hostType(String singularValue)

Singular setter. Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

hostId

public SummarizeHostInsightResourceUsageRequest.Builder hostId(String hostId)

Optional OCID of the host (Compute Id)

Parameters:

hostId - the value to set

Returns:

this builder instance

vmclusterName

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

status

public SummarizeHostInsightResourceUsageRequest.Builder status(List<ResourceStatus> status)

Resource Status

Parameters:

status - the value to set

Returns:

this builder instance

status

public SummarizeHostInsightResourceUsageRequest.Builder status(ResourceStatus singularValue)

Singular setter. Resource Status

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<SummarizeHostInsightResourceUsageRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public SummarizeHostInsightResourceUsageRequest build()

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

Returns:

instance of SummarizeHostInsightResourceUsageRequest

buildWithoutInvocationCallback

public SummarizeHostInsightResourceUsageRequest buildWithoutInvocationCallback()

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