Class ListSharesOptions

java.lang.Object

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

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

All Implemented Interfaces:

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

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

The listShares options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListSharesOptions.Builder	Builder.
static interface	ListSharesOptions.ReplicationRole	Filters the collection to file shares with a `replication_role` property matching the specified value.
static interface	ListSharesOptions.Sort	Sorts the returned collection by the specified property name in ascending order.

Method Summary

Modifier and Type	Method	Description
Long	limit()	Gets the limit.
String	name()	Gets the name.
ListSharesOptions.Builder	newBuilder()	New builder.
String	replicationRole()	Gets the replicationRole.
String	resourceGroupId()	Gets the resourceGroupId.
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 Details

newBuilder

public ListSharesOptions.Builder newBuilder()

New builder.

Returns:

a ListSharesOptions builder

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

resourceGroupId

public String resourceGroupId()

Gets the resourceGroupId. Filters the collection to resources with a `resource_group.id` property matching the specified identifier.

Returns:

the resourceGroupId

name

public String name()

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

Returns:

the name

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

replicationRole

public String replicationRole()

Gets the replicationRole. Filters the collection to file shares with a `replication_role` property matching the specified value.

Returns:

the replicationRole