Package com.oracle.bmc.resourcemanager.requests

Class ListTemplatesRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.resourcemanager.requests.ListTemplatesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180917")
public class ListTemplatesRequest
extends BmcRequest<Void>

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/resourcemanager/ListTemplatesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTemplatesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListTemplatesRequest.Builder
static class	ListTemplatesRequest.SortBy	The field to use when sorting returned resources.
static class	ListTemplatesRequest.SortOrder	The sort order to use when sorting returned resources.

Constructor Summary

Constructors

Constructor	Description
ListTemplatesRequest()

Method Summary

Modifier and Type	Method	Description
static ListTemplatesRequest.Builder	builder()	Return a new builder for this request object.
boolean	equals(Object o)	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId()	A filter to return only resources that exist in the compartment, identified by OCID.
String	getDisplayName()	A filter to return only resources that match the given display name exactly.
Integer	getLimit()	The number of items returned in a paginated List call.
String	getOpcRequestId()	Unique Oracle-assigned identifier for the request.
String	getPage()	The value of the opc-next-page response header from the preceding List call.
ListTemplatesRequest.SortBy	getSortBy()	The field to use when sorting returned resources.
ListTemplatesRequest.SortOrder	getSortOrder()	The sort order to use when sorting returned resources.
String	getTemplateCategoryId()	Unique identifier for the template category.
String	getTemplateId()	The OCID of the template.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListTemplatesRequest.Builder	toBuilder()	Return an instance of ListTemplatesRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListTemplatesRequest

public ListTemplatesRequest()

Method Detail

getOpcRequestId

public String getOpcRequestId()

Unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID.

getCompartmentId

public String getCompartmentId()

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

getTemplateCategoryId

public String getTemplateCategoryId()

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.

getTemplateId

public String getTemplateId()

The OCID of the template.

getDisplayName

public String getDisplayName()

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.

getSortBy

public ListTemplatesRequest.SortBy getSortBy()

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.

getSortOrder

public ListTemplatesRequest.SortOrder getSortOrder()

The sort order to use when sorting returned resources.

Ascending (ASC) or descending (DESC).

getLimit

public Integer getLimit()

The number of items returned in a paginated List call.

For information about pagination, see List Pagination.

getPage

public String getPage()

The value of the opc-next-page response header from the preceding List call.

For information about pagination, see List Pagination.

toBuilder

public ListTemplatesRequest.Builder toBuilder()

Return an instance of ListTemplatesRequest.Builder that allows you to modify request properties.

Returns:

instance of ListTemplatesRequest.Builder that allows you to modify request properties.

builder

public static ListTemplatesRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>