Package com.oracle.bmc.datacc.requests

Class ListVmInstancesRequest.Builder

java.lang.Object

com.oracle.bmc.datacc.requests.ListVmInstancesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListVmInstancesRequest,Void>

Enclosing class:

ListVmInstancesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListVmInstancesRequest.Builder	baseServerId(String baseServerId)	The OCID of the Database Infrastructure Server Id.
ListVmInstancesRequest	build()	Build the instance of ListVmInstancesRequest as configured by this builder
ListVmInstancesRequest	buildWithoutInvocationCallback()	Build the instance of ListVmInstancesRequest as configured by this builder
ListVmInstancesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListVmInstancesRequest.Builder	copy(ListVmInstancesRequest o)	Copy method to populate the builder with values from the given instance.
ListVmInstancesRequest.Builder	displayName(String displayName)	A filter to return resources that match the entire display name given.
ListVmInstancesRequest.Builder	infrastructureId(String infrastructureId)	The OCID of the Database Infrastructure.
ListVmInstancesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListVmInstancesRequest.Builder	lifecycleState(VmInstanceLifecycleState singularValue)	Singular setter.
ListVmInstancesRequest.Builder	lifecycleState(List<VmInstanceLifecycleState> lifecycleState)	A filter to return resources that match the specified lifecycle state.
ListVmInstancesRequest.Builder	limit(Integer limit)	The maximum number of items to return in a page.
ListVmInstancesRequest.Builder	opcRequestId(String opcRequestId)	The client request identifier.
ListVmInstancesRequest.Builder	page(String page)	The page token representing the page at which you want to start retrieving results.
ListVmInstancesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListVmInstancesRequest.Builder	sortBy(ListVmInstancesRequest.SortBy sortBy)	The field by which you want to sort.
ListVmInstancesRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order that you want to use, which is 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 ListVmInstancesRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

For list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided, it will be validated against the caller’s tenant and then treated as tenant scope (compartmentId filtering is not applied).

Parameters:

compartmentId - the value to set

Returns:

this builder instance

displayName

public ListVmInstancesRequest.Builder displayName(String displayName)

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

The match is case sensitive.

Parameters:

displayName - the value to set

Returns:

this builder instance

lifecycleState

public ListVmInstancesRequest.Builder lifecycleState(List<VmInstanceLifecycleState> lifecycleState)

A filter to return resources that match the specified lifecycle state.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

lifecycleState

public ListVmInstancesRequest.Builder lifecycleState(VmInstanceLifecycleState singularValue)

Singular setter.

A filter to return resources that match the specified lifecycle state.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

limit

public ListVmInstancesRequest.Builder limit(Integer limit)

The maximum number of items to return in a page.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListVmInstancesRequest.Builder page(String page)

The page token representing the page at which you want to start retrieving results.

This token is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListVmInstancesRequest.Builder sortOrder(SortOrder sortOrder)

The sort order that you want to use, which is either ASC or DESC.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListVmInstancesRequest.Builder sortBy(ListVmInstancesRequest.SortBy sortBy)

The field by which you want to sort.

You can provide only one type of sort order. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. When listing software images within the same version, using sortBy=buildIdentifier is recommended. buildIdentifier is a monotonically increasing, time-ordered string marker (yyyy-mm-dd-hh:mm:ss) stored with the image.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListVmInstancesRequest.Builder opcRequestId(String opcRequestId)

The client request identifier.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

infrastructureId

public ListVmInstancesRequest.Builder infrastructureId(String infrastructureId)

The OCID of the Database Infrastructure.

Parameters:

infrastructureId - the value to set

Returns:

this builder instance

baseServerId

public ListVmInstancesRequest.Builder baseServerId(String baseServerId)

The OCID of the Database Infrastructure Server Id.

Parameters:

baseServerId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListVmInstancesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListVmInstancesRequest build()

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

Returns:

instance of ListVmInstancesRequest

buildWithoutInvocationCallback

public ListVmInstancesRequest buildWithoutInvocationCallback()

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