Package com.oracle.bmc.oda.requests

Class ListPackagesRequest.Builder

java.lang.Object

com.oracle.bmc.oda.requests.ListPackagesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListPackagesRequest,Void>

Enclosing class:

ListPackagesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListPackagesRequest	build()	Build the instance of ListPackagesRequest as configured by this builder
ListPackagesRequest	buildWithoutInvocationCallback()	Build the instance of ListPackagesRequest as configured by this builder
ListPackagesRequest.Builder	compartmentId(String compartmentId)	List the packages that belong to this compartment.
ListPackagesRequest.Builder	copy(ListPackagesRequest o)	Copy method to populate the builder with values from the given instance.
ListPackagesRequest.Builder	displayName(String displayName)	List only the information for the Digital Assistant instance with this user-friendly name.
ListPackagesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListPackagesRequest.Builder	isLatestVersionOnly(Boolean isLatestVersionOnly)	Should we return only the latest version of a package (instead of all versions)?
ListPackagesRequest.Builder	limit(Integer limit)	The maximum number of items to return per page.
ListPackagesRequest.Builder	name(String name)	List only the information for the package with this name.
ListPackagesRequest.Builder	odaInstanceId(String odaInstanceId)	List only the information for this Digital Assistant instance.
ListPackagesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListPackagesRequest.Builder	page(String page)	The page at which to start retrieving results.
ListPackagesRequest.Builder	resourceType(String resourceType)	Resource type identifier.
ListPackagesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListPackagesRequest.Builder	sortBy(ListPackagesRequest.SortBy sortBy)	Sort on this field.
ListPackagesRequest.Builder	sortOrder(ListPackagesRequest.SortOrder sortOrder)	Sort the results in this order, use either ASC (ascending) or DESC (descending).

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

odaInstanceId

public ListPackagesRequest.Builder odaInstanceId(String odaInstanceId)

List only the information for this Digital Assistant instance.

Parameters:

odaInstanceId - the value to set

Returns:

this builder instance

resourceType

public ListPackagesRequest.Builder resourceType(String resourceType)

Resource type identifier.

Used to limit query results to the items which are applicable to the given type.

Parameters:

resourceType - the value to set

Returns:

this builder instance

compartmentId

public ListPackagesRequest.Builder compartmentId(String compartmentId)

List the packages that belong to this compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

name

public ListPackagesRequest.Builder name(String name)

List only the information for the package with this name.

Package names are unique to a publisher and may not change.

Example: My Package

Parameters:

name - the value to set

Returns:

this builder instance

displayName

public ListPackagesRequest.Builder displayName(String displayName)

List only the information for the Digital Assistant instance with this user-friendly name.

These names don’t have to be unique and may change.

Example: My new resource

Parameters:

displayName - the value to set

Returns:

this builder instance

isLatestVersionOnly

public ListPackagesRequest.Builder isLatestVersionOnly(Boolean isLatestVersionOnly)

Should we return only the latest version of a package (instead of all versions)?

Parameters:

isLatestVersionOnly - the value to set

Returns:

this builder instance

limit

public ListPackagesRequest.Builder limit(Integer limit)

The maximum number of items to return per page.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListPackagesRequest.Builder page(String page)

The page at which to start retrieving results.

You get this value from the opc-next-page header in a previous list request. To retireve the first page, omit this query parameter.

Example: MToxMA==

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListPackagesRequest.Builder sortOrder(ListPackagesRequest.SortOrder sortOrder)

Sort the results in this order, use either ASC (ascending) or DESC (descending).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListPackagesRequest.Builder sortBy(ListPackagesRequest.SortBy sortBy)

Sort on this field.

You can specify one sort order only. The default sort field is TIMECREATED.

The default sort order for TIMECREATED is descending, and the default sort order for DISPLAYNAME is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListPackagesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

This value is included in the opc-request-id response header.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListPackagesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListPackagesRequest build()

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

Returns:

instance of ListPackagesRequest

buildWithoutInvocationCallback

public ListPackagesRequest buildWithoutInvocationCallback()

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