Package com.ibm.cloud.is.vpc.v1.model

Class ListShareSnapshotsOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.is.vpc.v1.model.ListShareSnapshotsOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class ListShareSnapshotsOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The listShareSnapshots options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListShareSnapshotsOptions.Builder	Builder.
static interface	ListShareSnapshotsOptions.Sort	Sorts the returned collection by the specified property name in ascending order.

Method Summary

Modifier and Type	Method	Description
String	backupPolicyPlanId()	Gets the backupPolicyPlanId.
Long	limit()	Gets the limit.
String	name()	Gets the name.
ListShareSnapshotsOptions.Builder	newBuilder()	New builder.
String	shareId()	Gets the shareId.
String	sort()	Gets the sort.
String	start()	Gets the start.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public ListShareSnapshotsOptions.Builder newBuilder()

New builder.

Returns:

a ListShareSnapshotsOptions builder

shareId

public String shareId()

Gets the shareId. The file share identifier, or `-` to wildcard all accessible file shares.

Returns:

the shareId

backupPolicyPlanId

public String backupPolicyPlanId()

Gets the backupPolicyPlanId. Filters the collection to backup policy jobs with a `backup_policy_plan.id` property matching the specified identifier.

Returns:

the backupPolicyPlanId

name

public String name()

Gets the name. Filters the collection to resources with a `name` property matching the exact specified name.

Returns:

the name

start

public String start()

Gets the start. A server-provided token determining what resource to start the page on.

Returns:

the start

limit

public Long limit()

Gets the limit. The number of resources to return on a page.

Returns:

the limit

sort

public String sort()

Gets the sort. Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property in descending order, and the value `name` sorts it by the `name` property in ascending order.

Returns:

the sort