com.oracle.bmc.resourcemanager.requests

Class ListTemplatesRequest.Builder

java.lang.Object

com.oracle.bmc.resourcemanager.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 and Description
Builder()

Method Summary

Modifier and Type	Method and 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) A filter to return only resources that exist in the compartment, identified by OCID.
ListTemplatesRequest.Builder	copy(ListTemplatesRequest o) Copy method to populate the builder with values from the given instance.
ListTemplatesRequest.Builder	displayName(String displayName) A filter to return only resources that match the given display name exactly.
ListTemplatesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListTemplatesRequest.Builder	limit(Integer limit) The number of items returned in a paginated List call.
ListTemplatesRequest.Builder	opcRequestId(String opcRequestId) Unique Oracle-assigned identifier for the request.
ListTemplatesRequest.Builder	page(String page) The value of the opc-next-page response header from the preceding List call.
ListTemplatesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListTemplatesRequest.Builder	sortBy(ListTemplatesRequest.SortBy sortBy) The field to use when sorting returned resources.
ListTemplatesRequest.Builder	sortOrder(ListTemplatesRequest.SortOrder sortOrder) The sort order to use when sorting returned resources.
ListTemplatesRequest.Builder	templateCategoryId(String templateCategoryId) Unique identifier for the template category.
ListTemplatesRequest.Builder	templateId(String templateId) The OCID of the template.

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

opcRequestId

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

compartmentId

public ListTemplatesRequest.Builder compartmentId(String compartmentId)

A filter to return only resources that exist in the compartment, identified by OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

templateCategoryId

public ListTemplatesRequest.Builder templateCategoryId(String templateCategoryId)

Unique identifier for the template category. Possible values are 0 (Quickstarts), 1 (Service), 2 (Architecture), and 3 (Private). Template category labels are displayed in the Console page listing templates. Quickstarts, Service, and Architecture templates (categories 0, 1, and 2) are available in all compartments. Each private template (category 3) is available in the compartment where it was created.

Parameters:

templateCategoryId - the value to set

Returns:

this builder instance

templateId

public ListTemplatesRequest.Builder templateId(String templateId)

The OCID of the template.

Parameters:

templateId - the value to set

Returns:

this builder instance

displayName

public ListTemplatesRequest.Builder displayName(String displayName)

A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.

Parameters:

displayName - the value to set

Returns:

this builder instance

sortBy

public ListTemplatesRequest.Builder sortBy(ListTemplatesRequest.SortBy sortBy)

The field to use when sorting returned resources. By default, TIMECREATED is ordered descending. By default, DISPLAYNAME is ordered ascending. Note that you can sort only on one field.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListTemplatesRequest.Builder sortOrder(ListTemplatesRequest.SortOrder sortOrder)

The sort order to use when sorting returned resources. Ascending (ASC) or descending (DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

public ListTemplatesRequest.Builder limit(Integer limit)

The number of items returned in a paginated List call. For information about pagination, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListTemplatesRequest.Builder page(String page)

The value of the opc-next-page response header from the preceding List call. For information about pagination, see List Pagination.

Parameters:

page - 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