Class ListVolumesOptions

java.lang.Object

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

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

All Implemented Interfaces:

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

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

The listVolumes options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListVolumesOptions.AttachmentState	Filters the collection to volumes with an `attachment_state` property matching the specified value.
static class	ListVolumesOptions.Builder	Builder.
static interface	ListVolumesOptions.Encryption	Filters the collection to resources with an `encryption` property matching the specified value.

Method Summary

Modifier and Type	Method	Description
String	attachmentState()	Gets the attachmentState.
String	encryption()	Gets the encryption.
Long	limit()	Gets the limit.
String	name()	Gets the name.
ListVolumesOptions.Builder	newBuilder()	New builder.
String	operatingSystemArchitecture()	Gets the operatingSystemArchitecture.
String	operatingSystemFamily()	Gets the operatingSystemFamily.
String	start()	Gets the start.
String	tag()	Gets the tag.
String	zoneName()	Gets the zoneName.

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 ListVolumesOptions.Builder newBuilder()

New builder.

Returns:

a ListVolumesOptions 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

name

public String name()

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

Returns:

the name

attachmentState

public String attachmentState()

Gets the attachmentState. Filters the collection to volumes with an `attachment_state` property matching the specified value.

Returns:

the attachmentState

encryption

public String encryption()

Gets the encryption. Filters the collection to resources with an `encryption` property matching the specified value.

Returns:

the encryption

operatingSystemFamily

public String operatingSystemFamily()

Gets the operatingSystemFamily. Filters the collection to resources with an `operating_system.family` property matching the specified operating system family. This parameter also supports the values `null` and `not:null` which filter the collection to resources which have no operating system or any operating system, respectively.

Returns:

the operatingSystemFamily

operatingSystemArchitecture

public String operatingSystemArchitecture()

Gets the operatingSystemArchitecture. Filters the collection to resources with an `operating_system.architecture` property matching the specified operating system architecture. This parameter also supports the values `null` and `not:null` which filter the collection to resources which have no operating system or any operating system, respectively.

Returns:

the operatingSystemArchitecture

zoneName

public String zoneName()

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

Returns:

the zoneName

tag

public String tag()

Gets the tag. Filters the collection to resources with an item in the `tags` property matching the exact specified tag.

Returns:

the tag