com.oracle.bmc.opsi.requests

Class SummarizeHostInsightResourceForecastTrendRequest.Builder

java.lang.Object

com.oracle.bmc.opsi.requests.SummarizeHostInsightResourceForecastTrendRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<SummarizeHostInsightResourceForecastTrendRequest,Void>

Enclosing class:

SummarizeHostInsightResourceForecastTrendRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SummarizeHostInsightResourceForecastTrendRequest.Builder	analysisTimeInterval(String analysisTimeInterval) Specify time period in ISO 8601 format with respect to current time.
SummarizeHostInsightResourceForecastTrendRequest	build() Build the instance of SummarizeHostInsightResourceForecastTrendRequest as configured by this builder
SummarizeHostInsightResourceForecastTrendRequest	buildWithoutInvocationCallback() Build the instance of SummarizeHostInsightResourceForecastTrendRequest as configured by this builder
SummarizeHostInsightResourceForecastTrendRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment.
SummarizeHostInsightResourceForecastTrendRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree) A flag to search all resources within a given compartment and all sub-compartments.
SummarizeHostInsightResourceForecastTrendRequest.Builder	confidence(Integer confidence) This parameter is used to change data’s confidence level, this data is ingested by the forecast algorithm.
SummarizeHostInsightResourceForecastTrendRequest.Builder	copy(SummarizeHostInsightResourceForecastTrendRequest o) Copy method to populate the builder with values from the given instance.
SummarizeHostInsightResourceForecastTrendRequest.Builder	definedTagEquals(List<String> definedTagEquals) A list of tag filters to apply.
SummarizeHostInsightResourceForecastTrendRequest.Builder	definedTagEquals(String singularValue) Singular setter.
SummarizeHostInsightResourceForecastTrendRequest.Builder	definedTagExists(List<String> definedTagExists) A list of tag existence filters to apply.
SummarizeHostInsightResourceForecastTrendRequest.Builder	definedTagExists(String singularValue) Singular setter.
SummarizeHostInsightResourceForecastTrendRequest.Builder	exadataInsightId(List<String> exadataInsightId) Optional list of exadata insight resource OCIDs.
SummarizeHostInsightResourceForecastTrendRequest.Builder	exadataInsightId(String singularValue) Singular setter.
SummarizeHostInsightResourceForecastTrendRequest.Builder	forecastDays(Integer forecastDays) Number of days used for utilization forecast analysis.
SummarizeHostInsightResourceForecastTrendRequest.Builder	forecastModel(SummarizeHostInsightResourceForecastTrendRequest.ForecastModel forecastModel) Choose algorithm model for the forecasting.
SummarizeHostInsightResourceForecastTrendRequest.Builder	freeformTagEquals(List<String> freeformTagEquals) A list of tag filters to apply.
SummarizeHostInsightResourceForecastTrendRequest.Builder	freeformTagEquals(String singularValue) Singular setter.
SummarizeHostInsightResourceForecastTrendRequest.Builder	freeformTagExists(List<String> freeformTagExists) A list of tag existence filters to apply.
SummarizeHostInsightResourceForecastTrendRequest.Builder	freeformTagExists(String singularValue) Singular setter.
SummarizeHostInsightResourceForecastTrendRequest.Builder	gpuId(Integer gpuId) GPU identifier.
SummarizeHostInsightResourceForecastTrendRequest.Builder	highUtilizationThreshold(Integer highUtilizationThreshold) Percent value in which a resource metric is considered highly utilized.
SummarizeHostInsightResourceForecastTrendRequest.Builder	hostId(String hostId) Optional OCID of the host (Compute Id)
SummarizeHostInsightResourceForecastTrendRequest.Builder	hostType(List<String> hostType) Filter by one or more host types.
SummarizeHostInsightResourceForecastTrendRequest.Builder	hostType(String singularValue) Singular setter.
SummarizeHostInsightResourceForecastTrendRequest.Builder	id(List<String> id) Optional list of host insight resource OCIDs.
SummarizeHostInsightResourceForecastTrendRequest.Builder	id(String singularValue) Singular setter.
SummarizeHostInsightResourceForecastTrendRequest.Builder	interfaceName(String interfaceName) Name of the network interface.
SummarizeHostInsightResourceForecastTrendRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
SummarizeHostInsightResourceForecastTrendRequest.Builder	lowUtilizationThreshold(Integer lowUtilizationThreshold) Percent value in which a resource metric is considered low utilized.
SummarizeHostInsightResourceForecastTrendRequest.Builder	mountPoint(String mountPoint) Mount points are specialized NTFS filesystem objects.
SummarizeHostInsightResourceForecastTrendRequest.Builder	opcRequestId(String opcRequestId) Unique Oracle-assigned identifier for the request.
SummarizeHostInsightResourceForecastTrendRequest.Builder	page(String page) For list pagination.
SummarizeHostInsightResourceForecastTrendRequest.Builder	platformType(List<SummarizeHostInsightResourceForecastTrendRequest.PlatformType> platformType) Filter by one or more platform types.
SummarizeHostInsightResourceForecastTrendRequest.Builder	platformType(SummarizeHostInsightResourceForecastTrendRequest.PlatformType singularValue) Singular setter.
SummarizeHostInsightResourceForecastTrendRequest.Builder	resourceMetric(String resourceMetric) Filter by host resource metric.
SummarizeHostInsightResourceForecastTrendRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
SummarizeHostInsightResourceForecastTrendRequest.Builder	statistic(SummarizeHostInsightResourceForecastTrendRequest.Statistic statistic) Choose the type of statistic metric data to be used for forecasting.
SummarizeHostInsightResourceForecastTrendRequest.Builder	status(List<ResourceStatus> status) Resource Status
SummarizeHostInsightResourceForecastTrendRequest.Builder	status(ResourceStatus singularValue) Singular setter.
SummarizeHostInsightResourceForecastTrendRequest.Builder	timeIntervalEnd(Date timeIntervalEnd) Analysis end time in UTC in ISO 8601 format(exclusive).
SummarizeHostInsightResourceForecastTrendRequest.Builder	timeIntervalStart(Date timeIntervalStart) Analysis start time in UTC in ISO 8601 format(inclusive).
SummarizeHostInsightResourceForecastTrendRequest.Builder	utilizationLevel(SummarizeHostInsightResourceForecastTrendRequest.UtilizationLevel utilizationLevel) Filter by utilization level by the following buckets: - HIGH_UTILIZATION: DBs with utilization greater or equal than 75.
SummarizeHostInsightResourceForecastTrendRequest.Builder	vmclusterName(List<String> vmclusterName) Optional list of Exadata Insight VM cluster name.
SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

resourceMetric

public SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.Builder platformType(List<SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.Builder platformType(SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.Builder id(List<String> id)

Optional list of host insight resource OCIDs.

Parameters:

id - the value to set

Returns:

this builder instance

id

public SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.Builder exadataInsightId(List<String> exadataInsightId)

Optional list of exadata insight resource OCIDs.

Parameters:

exadataInsightId - the value to set

Returns:

this builder instance

exadataInsightId

public SummarizeHostInsightResourceForecastTrendRequest.Builder exadataInsightId(String singularValue)

Singular setter. Optional list of exadata insight resource OCIDs.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

statistic

public SummarizeHostInsightResourceForecastTrendRequest.Builder statistic(SummarizeHostInsightResourceForecastTrendRequest.Statistic statistic)

Choose the type of statistic metric data to be used for forecasting.

Parameters:

statistic - the value to set

Returns:

this builder instance

forecastDays

public SummarizeHostInsightResourceForecastTrendRequest.Builder forecastDays(Integer forecastDays)

Number of days used for utilization forecast analysis.

Parameters:

forecastDays - the value to set

Returns:

this builder instance

forecastModel

public SummarizeHostInsightResourceForecastTrendRequest.Builder forecastModel(SummarizeHostInsightResourceForecastTrendRequest.ForecastModel forecastModel)

Choose algorithm model for the forecasting. Possible values: - LINEAR: Uses linear regression algorithm for forecasting. - ML_AUTO: Automatically detects best algorithm to use for forecasting. - ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm.

Parameters:

forecastModel - the value to set

Returns:

this builder instance

utilizationLevel

public SummarizeHostInsightResourceForecastTrendRequest.Builder utilizationLevel(SummarizeHostInsightResourceForecastTrendRequest.UtilizationLevel utilizationLevel)

Filter by utilization level by the following buckets: - HIGH_UTILIZATION: DBs with utilization greater or equal than 75. - LOW_UTILIZATION: DBs with utilization lower than 25. - MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75. - MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50.

Parameters:

utilizationLevel - the value to set

Returns:

this builder instance

confidence

public SummarizeHostInsightResourceForecastTrendRequest.Builder confidence(Integer confidence)

This parameter is used to change data’s confidence level, this data is ingested by the forecast algorithm. Confidence is the probability of an interval to contain the expected population parameter. Manipulation of this value will lead to different results. If not set, default confidence value is 95%.

Parameters:

confidence - the value to set

Returns:

this builder instance

page

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

opcRequestId

public SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.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 SummarizeHostInsightResourceForecastTrendRequest.Builder hostId(String hostId)

Optional OCID of the host (Compute Id)

Parameters:

hostId - the value to set

Returns:

this builder instance

vmclusterName

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

mountPoint

public SummarizeHostInsightResourceForecastTrendRequest.Builder mountPoint(String mountPoint)

Mount points are specialized NTFS filesystem objects.

Parameters:

mountPoint - the value to set

Returns:

this builder instance

interfaceName

public SummarizeHostInsightResourceForecastTrendRequest.Builder interfaceName(String interfaceName)

Name of the network interface.

Parameters:

interfaceName - the value to set

Returns:

this builder instance

gpuId

public SummarizeHostInsightResourceForecastTrendRequest.Builder gpuId(Integer gpuId)

GPU identifier.

Parameters:

gpuId - the value to set

Returns:

this builder instance

status

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

Resource Status

Parameters:

status - the value to set

Returns:

this builder instance

status

public SummarizeHostInsightResourceForecastTrendRequest.Builder status(ResourceStatus singularValue)

Singular setter. Resource Status

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<SummarizeHostInsightResourceForecastTrendRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public SummarizeHostInsightResourceForecastTrendRequest build()

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

Returns:

instance of SummarizeHostInsightResourceForecastTrendRequest

buildWithoutInvocationCallback

public SummarizeHostInsightResourceForecastTrendRequest buildWithoutInvocationCallback()

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