Package com.oracle.bmc.opsi.requests

Class ListHostedEntitiesRequest.Builder

java.lang.Object

com.oracle.bmc.opsi.requests.ListHostedEntitiesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListHostedEntitiesRequest,Void>

Enclosing class:

ListHostedEntitiesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListHostedEntitiesRequest.Builder	analysisTimeInterval(String analysisTimeInterval)	Specify time period in ISO 8601 format with respect to current time.
ListHostedEntitiesRequest	build()	Build the instance of ListHostedEntitiesRequest as configured by this builder
ListHostedEntitiesRequest	buildWithoutInvocationCallback()	Build the instance of ListHostedEntitiesRequest as configured by this builder
ListHostedEntitiesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListHostedEntitiesRequest.Builder	copy(ListHostedEntitiesRequest o)	Copy method to populate the builder with values from the given instance.
ListHostedEntitiesRequest.Builder	exadataInsightId(String exadataInsightId)	OCID of exadata insight resource.
ListHostedEntitiesRequest.Builder	hostId(String hostId)	Optional OCID of the host (Compute Id)
ListHostedEntitiesRequest.Builder	hostType(String singularValue)	Singular setter.
ListHostedEntitiesRequest.Builder	hostType(List<String> hostType)	Filter by one or more host types.
ListHostedEntitiesRequest.Builder	id(String id)	Required OCID of the host insight resource.
ListHostedEntitiesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListHostedEntitiesRequest.Builder	limit(Integer limit)	For list pagination.
ListHostedEntitiesRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListHostedEntitiesRequest.Builder	page(String page)	For list pagination.
ListHostedEntitiesRequest.Builder	platformType(ListHostedEntitiesRequest.PlatformType singularValue)	Singular setter.
ListHostedEntitiesRequest.Builder	platformType(List<ListHostedEntitiesRequest.PlatformType> platformType)	Filter by one or more platform types.
ListHostedEntitiesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListHostedEntitiesRequest.Builder	sortBy(ListHostedEntitiesRequest.SortBy sortBy)	Hosted entity list sort options.
ListHostedEntitiesRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListHostedEntitiesRequest.Builder	status(ResourceStatus singularValue)	Singular setter.
ListHostedEntitiesRequest.Builder	status(List<ResourceStatus> status)	Resource Status
ListHostedEntitiesRequest.Builder	timeIntervalEnd(Date timeIntervalEnd)	Analysis end time in UTC in ISO 8601 format(exclusive).
ListHostedEntitiesRequest.Builder	timeIntervalStart(Date timeIntervalStart)	Analysis start time in UTC in ISO 8601 format(inclusive).

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

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

id

public ListHostedEntitiesRequest.Builder id(String id)

Required OCID of the host insight resource.

Parameters:

id - the value to set

Returns:

this builder instance

analysisTimeInterval

public ListHostedEntitiesRequest.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 ListHostedEntitiesRequest.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 ListHostedEntitiesRequest.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 ListHostedEntitiesRequest.Builder platformType(List<ListHostedEntitiesRequest.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 ListHostedEntitiesRequest.Builder platformType(ListHostedEntitiesRequest.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

exadataInsightId

public ListHostedEntitiesRequest.Builder exadataInsightId(String exadataInsightId)

OCID of exadata insight resource.

Parameters:

exadataInsightId - the value to set

Returns:

this builder instance

limit

public ListHostedEntitiesRequest.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 ListHostedEntitiesRequest.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 ListHostedEntitiesRequest.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 ListHostedEntitiesRequest.Builder sortBy(ListHostedEntitiesRequest.SortBy sortBy)

Hosted entity list sort options.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

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

hostType

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

Optional OCID of the host (Compute Id)

Parameters:

hostId - the value to set

Returns:

this builder instance

status

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

Resource Status

Parameters:

status - the value to set

Returns:

this builder instance

status

public ListHostedEntitiesRequest.Builder status(ResourceStatus singularValue)

Singular setter.

Resource Status

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListHostedEntitiesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListHostedEntitiesRequest build()

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

Returns:

instance of ListHostedEntitiesRequest

buildWithoutInvocationCallback

public ListHostedEntitiesRequest buildWithoutInvocationCallback()

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