Package com.oracle.bmc.ailanguage.requests

Class ListModelsRequest.Builder

java.lang.Object

com.oracle.bmc.ailanguage.requests.ListModelsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListModelsRequest,Void>

Enclosing class:

ListModelsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListModelsRequest	build()	Build the instance of ListModelsRequest as configured by this builder
ListModelsRequest	buildWithoutInvocationCallback()	Build the instance of ListModelsRequest as configured by this builder
ListModelsRequest.Builder	compartmentId(String compartmentId)	The ID of the compartment in which to list resources.
ListModelsRequest.Builder	copy(ListModelsRequest o)	Copy method to populate the builder with values from the given instance.
ListModelsRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
ListModelsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListModelsRequest.Builder	lifecycleState(Model.LifecycleState lifecycleState)	Filter results by the specified lifecycle state.
ListModelsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListModelsRequest.Builder	modelId(String modelId)	unique model OCID.
ListModelsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListModelsRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListModelsRequest.Builder	projectId(String projectId)	The ID of the project for which to list the objects.
ListModelsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListModelsRequest.Builder	sortBy(ListModelsRequest.SortBy sortBy)	Specifies the field to sort by.
ListModelsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘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

compartmentId

public ListModelsRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

modelId

public ListModelsRequest.Builder modelId(String modelId)

unique model OCID.

Parameters:

modelId - the value to set

Returns:

this builder instance

projectId

public ListModelsRequest.Builder projectId(String projectId)

The ID of the project for which to list the objects.

Parameters:

projectId - the value to set

Returns:

this builder instance

lifecycleState

public ListModelsRequest.Builder lifecycleState(Model.LifecycleState lifecycleState)

Filter results by the specified lifecycle state.

Must be a valid state for the resource type.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListModelsRequest.Builder displayName(String displayName)

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

Parameters:

displayName - the value to set

Returns:

this builder instance

limit

public ListModelsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListModelsRequest.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 ListModelsRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use, either ‘asc’ or ‘desc’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListModelsRequest.Builder sortBy(ListModelsRequest.SortBy sortBy)

Specifies the field to sort by.

Accepts only one field. By default, when you sort by timeCreated, the results are shown in descending order. When you sort by displayName, the results are shown in ascending order. Sort order for the displayName field is case sensitive.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListModelsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListModelsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListModelsRequest build()

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

Returns:

instance of ListModelsRequest

buildWithoutInvocationCallback

public ListModelsRequest buildWithoutInvocationCallback()

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