com.oracle.bmc.opsi.requests

Class ListHostConfigurationsRequest.Builder

java.lang.Object

com.oracle.bmc.opsi.requests.ListHostConfigurationsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListHostConfigurationsRequest,Void>

Enclosing class:

ListHostConfigurationsRequest

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

Method Summary

Modifier and Type	Method and Description
ListHostConfigurationsRequest	build() Build the instance of ListHostConfigurationsRequest as configured by this builder
ListHostConfigurationsRequest	buildWithoutInvocationCallback()
ListHostConfigurationsRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment.
ListHostConfigurationsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree) A flag to search all resources within a given compartment and all sub-compartments.
ListHostConfigurationsRequest.Builder	copy(ListHostConfigurationsRequest o) Copy method to populate the builder with values from the given instance.
ListHostConfigurationsRequest.Builder	definedTagEquals(List<String> definedTagEquals) A list of tag filters to apply.
ListHostConfigurationsRequest.Builder	definedTagEquals(String singularValue) Singular setter.
ListHostConfigurationsRequest.Builder	definedTagExists(List<String> definedTagExists) A list of tag existence filters to apply.
ListHostConfigurationsRequest.Builder	definedTagExists(String singularValue) Singular setter.
ListHostConfigurationsRequest.Builder	enterpriseManagerBridgeId(String enterpriseManagerBridgeId) Unique Enterprise Manager bridge identifier
ListHostConfigurationsRequest.Builder	exadataInsightId(List<String> exadataInsightId) Optional list of exadata insight resource OCIDs.
ListHostConfigurationsRequest.Builder	exadataInsightId(String singularValue) Singular setter.
ListHostConfigurationsRequest.Builder	freeformTagEquals(List<String> freeformTagEquals) A list of tag filters to apply.
ListHostConfigurationsRequest.Builder	freeformTagEquals(String singularValue) Singular setter.
ListHostConfigurationsRequest.Builder	freeformTagExists(List<String> freeformTagExists) A list of tag existence filters to apply.
ListHostConfigurationsRequest.Builder	freeformTagExists(String singularValue) Singular setter.
ListHostConfigurationsRequest.Builder	id(List<String> id) Optional list of host insight resource OCIDs.
ListHostConfigurationsRequest.Builder	id(String singularValue) Singular setter.
ListHostConfigurationsRequest.Builder	invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback) Set the invocation callback for the request to be built.
ListHostConfigurationsRequest.Builder	limit(Integer limit) For list pagination.
ListHostConfigurationsRequest.Builder	opcRequestId(String opcRequestId) Unique Oracle-assigned identifier for the request.
ListHostConfigurationsRequest.Builder	page(String page) For list pagination.
ListHostConfigurationsRequest.Builder	platformType(List<ListHostConfigurationsRequest.PlatformType> platformType) Filter by one or more platform types.
ListHostConfigurationsRequest.Builder	platformType(ListHostConfigurationsRequest.PlatformType singularValue) Singular setter.
ListHostConfigurationsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListHostConfigurationsRequest.Builder	sortBy(ListHostConfigurationsRequest.SortBy sortBy) Host configuration list sort options.
ListHostConfigurationsRequest.Builder	sortOrder(SortOrder sortOrder) The sort order to use, either ascending (ASC) or descending (DESC).
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Method Detail

id

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

Optional list of host insight resource OCIDs.

Returns:

this builder instance

id

public ListHostConfigurationsRequest.Builder id(String singularValue)

Singular setter. Optional list of host insight resource OCIDs.

Returns:

this builder instance

exadataInsightId

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

Optional list of exadata insight resource OCIDs.

Returns:

this builder instance

exadataInsightId

public ListHostConfigurationsRequest.Builder exadataInsightId(String singularValue)

Singular setter. Optional list of exadata insight resource OCIDs.

Returns:

this builder instance

platformType

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

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

Returns:

this builder instance

platformType

public ListHostConfigurationsRequest.Builder platformType(ListHostConfigurationsRequest.PlatformType singularValue)

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

Returns:

this builder instance

definedTagEquals

public ListHostConfigurationsRequest.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”.

Returns:

this builder instance

definedTagEquals

public ListHostConfigurationsRequest.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”.

Returns:

this builder instance

freeformTagEquals

public ListHostConfigurationsRequest.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”.

Returns:

this builder instance

freeformTagEquals

public ListHostConfigurationsRequest.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”.

Returns:

this builder instance

definedTagExists

public ListHostConfigurationsRequest.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”.

Returns:

this builder instance

definedTagExists

public ListHostConfigurationsRequest.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”.

Returns:

this builder instance

freeformTagExists

public ListHostConfigurationsRequest.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”.

Returns:

this builder instance

freeformTagExists

public ListHostConfigurationsRequest.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”.

Returns:

this builder instance

invocationCallback

public ListHostConfigurationsRequest.Builder invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> 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 ListHostConfigurationsRequest.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 ListHostConfigurationsRequest.Builder copy(ListHostConfigurationsRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListHostConfigurationsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListHostConfigurationsRequest build()

Build the instance of ListHostConfigurationsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.util.internal.Consumer) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListHostConfigurationsRequest,Void>

Returns:

instance of ListHostConfigurationsRequest

compartmentId

public ListHostConfigurationsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Returns:

this.

enterpriseManagerBridgeId

public ListHostConfigurationsRequest.Builder enterpriseManagerBridgeId(String enterpriseManagerBridgeId)

Unique Enterprise Manager bridge identifier

Returns:

this.

limit

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

Returns:

this.

page

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

Returns:

this.

sortOrder

public ListHostConfigurationsRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC).

Returns:

this.

sortBy

public ListHostConfigurationsRequest.Builder sortBy(ListHostConfigurationsRequest.SortBy sortBy)

Host configuration list sort options.

Returns:

this.

opcRequestId

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

Returns:

this.

compartmentIdInSubtree

public ListHostConfigurationsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

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

Returns:

this.

buildWithoutInvocationCallback

public ListHostConfigurationsRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object