com.oracle.bmc.apmconfig.requests

Class ListConfigsRequest.Builder

java.lang.Object

com.oracle.bmc.apmconfig.requests.ListConfigsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListConfigsRequest,Void>

Enclosing class:

ListConfigsRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListConfigsRequest.Builder	apmDomainId(String apmDomainId) The APM Domain ID the request is intended for.
ListConfigsRequest	build() Build the instance of ListConfigsRequest as configured by this builder
ListConfigsRequest	buildWithoutInvocationCallback() Build the instance of ListConfigsRequest as configured by this builder
ListConfigsRequest.Builder	configType(String configType) A filter to match configuration items of a given type.
ListConfigsRequest.Builder	copy(ListConfigsRequest o) Copy method to populate the builder with values from the given instance.
ListConfigsRequest.Builder	definedTagEquals(List<String> definedTagEquals) A list of tag filters to apply.
ListConfigsRequest.Builder	definedTagEquals(String singularValue) Singular setter.
ListConfigsRequest.Builder	definedTagExists(List<String> definedTagExists) A list of tag existence filters to apply.
ListConfigsRequest.Builder	definedTagExists(String singularValue) Singular setter.
ListConfigsRequest.Builder	displayName(String displayName) A filter to return resources that match the given display name.
ListConfigsRequest.Builder	freeformTagEquals(List<String> freeformTagEquals) A list of tag filters to apply.
ListConfigsRequest.Builder	freeformTagEquals(String singularValue) Singular setter.
ListConfigsRequest.Builder	freeformTagExists(List<String> freeformTagExists) A list of tag existence filters to apply.
ListConfigsRequest.Builder	freeformTagExists(String singularValue) Singular setter.
ListConfigsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListConfigsRequest.Builder	limit(Integer limit) The maximum number of items to return.
ListConfigsRequest.Builder	opcRequestId(String opcRequestId) Unique identifier for the request.
ListConfigsRequest.Builder	optionsGroup(String optionsGroup) A filter to return OPTIONS resources that match the given group.
ListConfigsRequest.Builder	page(String page) The maximum number of results per page, or items to return in a paginated “List” call.
ListConfigsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListConfigsRequest.Builder	sortBy(ListConfigsRequest.SortBy sortBy) The field to sort by.
ListConfigsRequest.Builder	sortOrder(SortOrders sortOrder) The sort order to use, either ascending (ASC) or descending (DESC).

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

apmDomainId

public ListConfigsRequest.Builder apmDomainId(String apmDomainId)

The APM Domain ID the request is intended for.

Parameters:

apmDomainId - the value to set

Returns:

this builder instance

opcRequestId

public ListConfigsRequest.Builder opcRequestId(String opcRequestId)

Unique 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

configType

public ListConfigsRequest.Builder configType(String configType)

A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.

Parameters:

configType - the value to set

Returns:

this builder instance

displayName

public ListConfigsRequest.Builder displayName(String displayName)

A filter to return resources that match the given display name.

Parameters:

displayName - the value to set

Returns:

this builder instance

limit

public ListConfigsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListConfigsRequest.Builder page(String page)

The maximum number of results per page, or items to return in a paginated “List” call. For information on how pagination works, see List Pagination. Example: 50

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListConfigsRequest.Builder sortOrder(SortOrders sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC). The displayName sort order is case-sensitive.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListConfigsRequest.Builder sortBy(ListConfigsRequest.SortBy sortBy)

The field to sort by. You can provide one “sortBy” value. The default order for displayName, timeCreated and timeUpdated is ascending. The displayName sort by is case-sensitive.

Parameters:

sortBy - the value to set

Returns:

this builder instance

optionsGroup

public ListConfigsRequest.Builder optionsGroup(String optionsGroup)

A filter to return OPTIONS resources that match the given group.

Parameters:

optionsGroup - the value to set

Returns:

this builder instance

definedTagEquals

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

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListConfigsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListConfigsRequest build()

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

Returns:

instance of ListConfigsRequest

buildWithoutInvocationCallback

public ListConfigsRequest buildWithoutInvocationCallback()

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