Package com.oracle.bmc.loganalytics.requests

Class ListTemplatesRequest.Builder

java.lang.Object

com.oracle.bmc.loganalytics.requests.ListTemplatesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListTemplatesRequest,Void>

Enclosing class:

ListTemplatesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListTemplatesRequest	build()	Build the instance of ListTemplatesRequest as configured by this builder
ListTemplatesRequest	buildWithoutInvocationCallback()	Build the instance of ListTemplatesRequest as configured by this builder
ListTemplatesRequest.Builder	compartmentId(String compartmentId)	The ID of the compartment in which to list resources.
ListTemplatesRequest.Builder	copy(ListTemplatesRequest o)	Copy method to populate the builder with values from the given instance.
ListTemplatesRequest.Builder	filter(String filter)	filter
ListTemplatesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListTemplatesRequest.Builder	lifecycleState(ConfigLifecycleState lifecycleState)	The template lifecycle state used for filtering.
ListTemplatesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListTemplatesRequest.Builder	name(String name)	The template name used for filtering.
ListTemplatesRequest.Builder	namespaceName(String namespaceName)	The Logging Analytics namespace used for the request.
ListTemplatesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListTemplatesRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListTemplatesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListTemplatesRequest.Builder	sortBy(ListTemplatesRequest.SortBy sortBy)	The attribute used to sort the returned templates
ListTemplatesRequest.Builder	sortOrder(ListTemplatesRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListTemplatesRequest.Builder	templateDisplayText(String templateDisplayText)	The template display text used for filtering.
ListTemplatesRequest.Builder	type(String type)	The template type used for filtering.

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

namespaceName

public ListTemplatesRequest.Builder namespaceName(String namespaceName)

The Logging Analytics namespace used for the request.

Parameters:

namespaceName - the value to set

Returns:

this builder instance

compartmentId

public ListTemplatesRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

type

public ListTemplatesRequest.Builder type(String type)

The template type used for filtering.

Only templates of the specified type will be returned.

Parameters:

type - the value to set

Returns:

this builder instance

name

public ListTemplatesRequest.Builder name(String name)

The template name used for filtering.

Parameters:

name - the value to set

Returns:

this builder instance

templateDisplayText

public ListTemplatesRequest.Builder templateDisplayText(String templateDisplayText)

The template display text used for filtering.

Only templates with the specified name or description will be returned.

Parameters:

templateDisplayText - the value to set

Returns:

this builder instance

lifecycleState

public ListTemplatesRequest.Builder lifecycleState(ConfigLifecycleState lifecycleState)

The template lifecycle state used for filtering.

Currently supported values are ACTIVE and DELETED.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

filter

public ListTemplatesRequest.Builder filter(String filter)

filter

Parameters:

filter - the value to set

Returns:

this builder instance

limit

public ListTemplatesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListTemplatesRequest.Builder page(String page)

The page token representing the page at which to start retrieving results.

This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

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

The attribute used to sort the returned templates

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListTemplatesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListTemplatesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListTemplatesRequest build()

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

Returns:

instance of ListTemplatesRequest

buildWithoutInvocationCallback

public ListTemplatesRequest buildWithoutInvocationCallback()

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