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

Class ListBackupPolicyJobsOptions

java.lang.Object

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

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

All Implemented Interfaces:

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

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

The listBackupPolicyJobs options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListBackupPolicyJobsOptions.Builder	Builder.
static interface	ListBackupPolicyJobsOptions.Sort	Sorts the returned collection by the specified property name in ascending order.
static interface	ListBackupPolicyJobsOptions.Status	Filters the collection to backup policy jobs with a `status` property matching the specified value.

Method Summary

Modifier and Type	Method	Description
String	backupPolicyId()	Gets the backupPolicyId.
String	backupPolicyPlanId()	Gets the backupPolicyPlanId.
Long	limit()	Gets the limit.
ListBackupPolicyJobsOptions.Builder	newBuilder()	New builder.
String	sort()	Gets the sort.
String	sourceId()	Gets the sourceId.
String	start()	Gets the start.
String	status()	Gets the status.
String	targetSnapshotsCrn()	Gets the targetSnapshotsCrn.
String	targetSnapshotsId()	Gets the targetSnapshotsId.

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

New builder.

Returns:

a ListBackupPolicyJobsOptions builder

backupPolicyId

public String backupPolicyId()

Gets the backupPolicyId. The backup policy identifier.

Returns:

the backupPolicyId

status

public String status()

Gets the status. Filters the collection to backup policy jobs with a `status` property matching the specified value.

Returns:

the status

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

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

sourceId

public String sourceId()

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

Returns:

the sourceId

targetSnapshotsId

public String targetSnapshotsId()

Gets the targetSnapshotsId. Filters the collection to backup policy jobs with an item in the `target_snapshots` property with an `id` property matching the specified identifier.

Returns:

the targetSnapshotsId

targetSnapshotsCrn

public String targetSnapshotsCrn()

Gets the targetSnapshotsCrn. Filters the collection to backup policy jobs with an item in the `target_snapshots` property with a `crn` property matching the specified CRN.

Returns:

the targetSnapshotsCrn