com.oracle.bmc.cloudmigrations.requests

Class ListMigrationsRequest.Builder

java.lang.Object

com.oracle.bmc.cloudmigrations.requests.ListMigrationsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListMigrationsRequest,Void>

Enclosing class:

ListMigrationsRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListMigrationsRequest	build() Build the instance of ListMigrationsRequest as configured by this builder
ListMigrationsRequest	buildWithoutInvocationCallback() Build the instance of ListMigrationsRequest as configured by this builder
ListMigrationsRequest.Builder	compartmentId(String compartmentId) The ID of the compartment in which to list resources.
ListMigrationsRequest.Builder	copy(ListMigrationsRequest o) Copy method to populate the builder with values from the given instance.
ListMigrationsRequest.Builder	displayName(String displayName) A filter to return only resources that match the entire given display name.
ListMigrationsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListMigrationsRequest.Builder	lifecycleState(Migration.LifecycleState lifecycleState) A filter to return only resources where the resource’s lifecycle state matches the given lifecycle state.
ListMigrationsRequest.Builder	limit(Integer limit) The maximum number of items to return.
ListMigrationsRequest.Builder	migrationId(String migrationId) Unique migration identifier
ListMigrationsRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
ListMigrationsRequest.Builder	page(String page) A token representing the position at which to start retrieving results.
ListMigrationsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListMigrationsRequest.Builder	sortBy(ListMigrationsRequest.SortBy sortBy) The field to sort by.
ListMigrationsRequest.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 ListMigrationsRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListMigrationsRequest.Builder lifecycleState(Migration.LifecycleState lifecycleState)

A filter to return only resources where the resource’s lifecycle state matches the given lifecycle state.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListMigrationsRequest.Builder displayName(String displayName)

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

Parameters:

displayName - the value to set

Returns:

this builder instance

migrationId

public ListMigrationsRequest.Builder migrationId(String migrationId)

Unique migration identifier

Parameters:

migrationId - the value to set

Returns:

this builder instance

limit

public ListMigrationsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListMigrationsRequest.Builder page(String page)

A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of the previous response.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

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

The field to sort by. Only one sort order can be provided. The default order for ‘timeCreated’ is descending. The default order for ‘displayName’ is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListMigrationsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListMigrationsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListMigrationsRequest build()

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

Returns:

instance of ListMigrationsRequest

buildWithoutInvocationCallback

public ListMigrationsRequest buildWithoutInvocationCallback()

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