Package com.ibm.cloud.is.vpc.v1.model
Class ListSnapshotsOptions
- java.lang.Object
-
- com.ibm.cloud.sdk.core.service.model.GenericModel
-
- com.ibm.cloud.is.vpc.v1.model.ListSnapshotsOptions
-
- All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class ListSnapshotsOptions extends com.ibm.cloud.sdk.core.service.model.GenericModel
The listSnapshots options.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ListSnapshotsOptions.Builder
Builder.static interface
ListSnapshotsOptions.Sort
Sorts the returned collection by the specified property name in ascending order.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
backupPolicyPlanId()
Gets the backupPolicyPlanId.String
clonesZoneName()
Gets the clonesZoneName.String
copiesCrn()
Gets the copiesCrn.String
copiesId()
Gets the copiesId.String
copiesName()
Gets the copiesName.String
copiesRemoteRegionName()
Gets the copiesRemoteRegionName.Long
limit()
Gets the limit.String
name()
Gets the name.ListSnapshotsOptions.Builder
newBuilder()
New builder.String
resourceGroupId()
Gets the resourceGroupId.String
snapshotConsistencyGroupCrn()
Gets the snapshotConsistencyGroupCrn.String
snapshotConsistencyGroupId()
Gets the snapshotConsistencyGroupId.String
sort()
Gets the sort.String
sourceImageCrn()
Gets the sourceImageCrn.String
sourceImageId()
Gets the sourceImageId.String
sourceImageRemoteRegionName()
Gets the sourceImageRemoteRegionName.String
sourceSnapshotId()
Gets the sourceSnapshotId.String
sourceSnapshotRemoteRegionName()
Gets the sourceSnapshotRemoteRegionName.String
sourceVolumeCrn()
Gets the sourceVolumeCrn.String
sourceVolumeId()
Gets the sourceVolumeId.String
sourceVolumeRemoteRegionName()
Gets the sourceVolumeRemoteRegionName.String
start()
Gets the start.String
tag()
Gets the tag.
-
-
-
Method Detail
-
newBuilder
public ListSnapshotsOptions.Builder newBuilder()
New builder.- Returns:
- a ListSnapshotsOptions 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
-
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
-
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
-
sourceVolumeId
public String sourceVolumeId()
Gets the sourceVolumeId. Filters the collection to resources with a `source_volume.id` property matching the specified identifier.- Returns:
- the sourceVolumeId
-
sourceVolumeCrn
public String sourceVolumeCrn()
Gets the sourceVolumeCrn. Filters the collection to resources with a `source_volume.crn` property matching the specified CRN.- Returns:
- the sourceVolumeCrn
-
sourceImageId
public String sourceImageId()
Gets the sourceImageId. Filters the collection to resources with a `source_image.id` property matching the specified identifier. This parameter also supports the values `null` and `not:null` which filter the collection to resources which have no source image or any existent source image, respectively.- Returns:
- the sourceImageId
-
sourceImageCrn
public String sourceImageCrn()
Gets the sourceImageCrn. Filters the collection to resources with a `source_image.crn` property matching the specified CRN. This parameter also supports the values `null` and `not:null` which filter the collection to resources which have no source image or any existent source image, respectively.- Returns:
- the sourceImageCrn
-
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
-
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
-
copiesId
public String copiesId()
Gets the copiesId. Filters the collection to snapshots with an item in the `copies` property with an `id` property matching the specified identifier.- Returns:
- the copiesId
-
copiesName
public String copiesName()
Gets the copiesName. Filters the collection to snapshots with an item in the `copies` property with a `name` property matching the exact specified name.- Returns:
- the copiesName
-
copiesCrn
public String copiesCrn()
Gets the copiesCrn. Filters the collection to snapshots with an item in the `copies` property with an `id` property matching the specified CRN.- Returns:
- the copiesCrn
-
copiesRemoteRegionName
public String copiesRemoteRegionName()
Gets the copiesRemoteRegionName. Filters the collection to snapshots with an item in the `copies` property with a `remote.region.name` property matching the exact specified name.- Returns:
- the copiesRemoteRegionName
-
sourceSnapshotId
public String sourceSnapshotId()
Gets the sourceSnapshotId. Filters the collection to resources with a `source_snapshot.id` property matching the specified identifier.- Returns:
- the sourceSnapshotId
-
sourceSnapshotRemoteRegionName
public String sourceSnapshotRemoteRegionName()
Gets the sourceSnapshotRemoteRegionName. Filters the collection to resources with a `source_snapshot.remote.region.name` property matching the exact specified name.- Returns:
- the sourceSnapshotRemoteRegionName
-
sourceVolumeRemoteRegionName
public String sourceVolumeRemoteRegionName()
Gets the sourceVolumeRemoteRegionName. Filters the collection to resources with a `source_volume.remote.region.name` property matching the exact specified name.- Returns:
- the sourceVolumeRemoteRegionName
-
sourceImageRemoteRegionName
public String sourceImageRemoteRegionName()
Gets the sourceImageRemoteRegionName. Filters the collection to resources with a `source_image.remote.region.name` property matching the exact specified name.- Returns:
- the sourceImageRemoteRegionName
-
clonesZoneName
public String clonesZoneName()
Gets the clonesZoneName. Filters the collection to snapshots with an item in the `clones` property with a `zone.name` property matching the exact specified name.- Returns:
- the clonesZoneName
-
snapshotConsistencyGroupId
public String snapshotConsistencyGroupId()
Gets the snapshotConsistencyGroupId. Filters the collection to resources with a `snapshot_consistency_group.id` property matching the specified identifier.- Returns:
- the snapshotConsistencyGroupId
-
snapshotConsistencyGroupCrn
public String snapshotConsistencyGroupCrn()
Gets the snapshotConsistencyGroupCrn. Filters the collection to resources with a `snapshot_consistency_group.crn` property matching the specified identifier.- Returns:
- the snapshotConsistencyGroupCrn
-
-