Package com.oracle.bmc.core.requests

Class ListVolumeBackupsRequest

java.lang.Object

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

com.oracle.bmc.core.requests.ListVolumeBackupsRequest

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

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ListVolumeBackupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListVolumeBackupsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListVolumeBackupsRequest.Builder
static class	ListVolumeBackupsRequest.SortBy	The field to sort by.
static class	ListVolumeBackupsRequest.SortOrder	The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor	Description
ListVolumeBackupsRequest()

Method Summary

Modifier and Type	Method	Description
static ListVolumeBackupsRequest.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	getCompartmentId()	The OCID of the compartment.
String	getDisplayName()	A filter to return only resources that match the given display name exactly.
VolumeBackup.LifecycleState	getLifecycleState()	A filter to only return resources that match the given lifecycle state.
Integer	getLimit()	For list pagination.
String	getPage()	For list pagination.
ListVolumeBackupsRequest.SortBy	getSortBy()	The field to sort by.
ListVolumeBackupsRequest.SortOrder	getSortOrder()	The sort order to use, either ascending (ASC) or descending (DESC).
String	getSourceVolumeBackupId()	A filter to return only resources that originated from the given source volume backup.
String	getVolumeId()	The OCID of the volume.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListVolumeBackupsRequest.Builder	toBuilder()	Return an instance of ListVolumeBackupsRequest.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

ListVolumeBackupsRequest

public ListVolumeBackupsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getVolumeId

public String getVolumeId()

The OCID of the volume.

getLimit

public Integer getLimit()

For list pagination.

The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

Example: 50

getPage

public String getPage()

For list pagination.

The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

getDisplayName

public String getDisplayName()

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

getSourceVolumeBackupId

public String getSourceVolumeBackupId()

A filter to return only resources that originated from the given source volume backup.

getSortBy

public ListVolumeBackupsRequest.SortBy getSortBy()

The field to sort by.

You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

*Note:** In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

getSortOrder

public ListVolumeBackupsRequest.SortOrder getSortOrder()

The sort order to use, either ascending (ASC) or descending (DESC).

The DISPLAYNAME sort order is case sensitive.

getLifecycleState

public VolumeBackup.LifecycleState getLifecycleState()

A filter to only return resources that match the given lifecycle state.

The state value is case-insensitive.

toBuilder

public ListVolumeBackupsRequest.Builder toBuilder()

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

Returns:

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

builder

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