Package com.ibm.cloud.platform_services.resource_controller.v2.model

Class ListResourceInstancesOptions

java.lang.Object

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

com.ibm.cloud.platform_services.resource_controller.v2.model.ListResourceInstancesOptions

All Implemented Interfaces:

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

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

The listResourceInstances options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListResourceInstancesOptions.Builder	Builder.
static interface	ListResourceInstancesOptions.State	The state of the instance.

Method Summary

Modifier and Type	Method	Description
java.lang.String	guid()	Gets the guid.
java.lang.Long	limit()	Gets the limit.
java.lang.String	name()	Gets the name.
ListResourceInstancesOptions.Builder	newBuilder()	New builder.
java.lang.String	resourceGroupId()	Gets the resourceGroupId.
java.lang.String	resourceId()	Gets the resourceId.
java.lang.String	resourcePlanId()	Gets the resourcePlanId.
java.lang.String	start()	Gets the start.
java.lang.String	state()	Gets the state.
java.lang.String	subType()	Gets the subType.
java.lang.String	type()	Gets the type.
java.lang.String	updatedFrom()	Gets the updatedFrom.
java.lang.String	updatedTo()	Gets the updatedTo.

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

New builder.

Returns:

a ListResourceInstancesOptions builder

guid

public java.lang.String guid()

Gets the guid. The GUID of the instance.

Returns:

the guid

name

public java.lang.String name()

Gets the name. The human-readable name of the instance.

Returns:

the name

resourceGroupId

public java.lang.String resourceGroupId()

Gets the resourceGroupId. The ID of the resource group.

Returns:

the resourceGroupId

resourceId

public java.lang.String resourceId()

Gets the resourceId. The unique ID of the offering. This value is provided by and stored in the global catalog.

Returns:

the resourceId

resourcePlanId

public java.lang.String resourcePlanId()

Gets the resourcePlanId. The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.

Returns:

the resourcePlanId

type

public java.lang.String type()

Gets the type. The type of the instance, for example, `service_instance`.

Returns:

the type

subType

public java.lang.String subType()

Gets the subType. The sub-type of instance, for example, `kms`.

Returns:

the subType

limit

public java.lang.Long limit()

Gets the limit. Limit on how many items should be returned.

Returns:

the limit

start

public java.lang.String start()

Gets the start. An optional token that indicates the beginning of the page of results to be returned. Any additional query parameters are ignored if a page token is present. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the 'next_url' field of the operation response.

Returns:

the start

state

public java.lang.String state()

Gets the state. The state of the instance. If not specified, instances in state `active` and `provisioning` are returned.

Returns:

the state

updatedFrom

public java.lang.String updatedFrom()

Gets the updatedFrom. Start date inclusive filter.

Returns:

the updatedFrom

updatedTo

public java.lang.String updatedTo()

Gets the updatedTo. End date inclusive filter.

Returns:

the updatedTo