com.oracle.bmc.goldengate.requests

Class ListDeploymentsRequest

java.lang.Object

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

com.oracle.bmc.goldengate.requests.ListDeploymentsRequest

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

Example: Click here to see how to use ListDeploymentsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListDeploymentsRequest.Builder
static class	ListDeploymentsRequest.SortBy The field to sort by.

Constructor Summary

Constructors

Constructor and Description
ListDeploymentsRequest()

Method Summary

Modifier and Type	Method and Description
static ListDeploymentsRequest.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	getAssignableConnectionId() Return the deployments to which the specified connectionId may be assigned.
String	getAssignedConnectionId() The OCID of the connection which for the deployment must be assigned.
String	getCompartmentId() The OCID of the compartment that contains the work request.
String	getDisplayName() A filter to return only the resources that match the entire ‘displayName’ given.
String	getFqdn() A filter to return only the resources that match the ‘fqdn’ given.
LifecycleState	getLifecycleState() A filter to return only the resources that match the ‘lifecycleState’ given.
LifecycleSubState	getLifecycleSubState() A filter to return only the resources that match the ‘lifecycleSubState’ given.
Integer	getLimit() The maximum number of items to return.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page token representing the page at which to start retrieving results.
ListDeploymentsRequest.SortBy	getSortBy() The field to sort by.
SortOrder	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’.
ConnectionType	getSupportedConnectionType() The connection type which the deployment must support.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListDeploymentsRequest.Builder	toBuilder() Return an instance of ListDeploymentsRequest.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

ListDeploymentsRequest

public ListDeploymentsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

getSupportedConnectionType

public ConnectionType getSupportedConnectionType()

The connection type which the deployment must support.

getAssignedConnectionId

public String getAssignedConnectionId()

The OCID of the connection which for the deployment must be assigned.

getAssignableConnectionId

public String getAssignableConnectionId()

Return the deployments to which the specified connectionId may be assigned.

getLifecycleState

public LifecycleState getLifecycleState()

A filter to return only the resources that match the ‘lifecycleState’ given.

getLifecycleSubState

public LifecycleSubState getLifecycleSubState()

A filter to return only the resources that match the ‘lifecycleSubState’ given.

getDisplayName

public String getDisplayName()

A filter to return only the resources that match the entire ‘displayName’ given.

getFqdn

public String getFqdn()

A filter to return only the resources that match the ‘fqdn’ given.

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

getSortOrder

public SortOrder getSortOrder()

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

getSortBy

public ListDeploymentsRequest.SortBy getSortBy()

The field to sort by. Only one sort order can be provided. Default order for ‘timeCreated’ is descending. Default order for ‘displayName’ is ascending. If no value is specified timeCreated is the default.

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

toBuilder

public ListDeploymentsRequest.Builder toBuilder()

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

Returns:

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

builder

public static ListDeploymentsRequest.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>