com.google.cloud.aiplatform.v1beta1

Interface PersistentResourceOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PersistentResource, PersistentResource.Builder

public interface PersistentResourceOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDisplayName() Optional.
com.google.protobuf.ByteString	getDisplayNameBytes() Optional.
EncryptionSpec	getEncryptionSpec() Optional.
EncryptionSpecOrBuilder	getEncryptionSpecOrBuilder() Optional.
com.google.rpc.Status	getError() Output only.
com.google.rpc.StatusOrBuilder	getErrorOrBuilder() Output only.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
String	getNetwork() Optional.
com.google.protobuf.ByteString	getNetworkBytes() Optional.
PscInterfaceConfig	getPscInterfaceConfig() Optional.
PscInterfaceConfigOrBuilder	getPscInterfaceConfigOrBuilder() Optional.
String	getReservedIpRanges(int index) Optional.
com.google.protobuf.ByteString	getReservedIpRangesBytes(int index) Optional.
int	getReservedIpRangesCount() Optional.
List<String>	getReservedIpRangesList() Optional.
ResourcePool	getResourcePools(int index) Required.
int	getResourcePoolsCount() Required.
List<ResourcePool>	getResourcePoolsList() Required.
ResourcePoolOrBuilder	getResourcePoolsOrBuilder(int index) Required.
List<? extends ResourcePoolOrBuilder>	getResourcePoolsOrBuilderList() Required.
ResourceRuntime	getResourceRuntime() Output only.
ResourceRuntimeOrBuilder	getResourceRuntimeOrBuilder() Output only.
ResourceRuntimeSpec	getResourceRuntimeSpec() Optional.
ResourceRuntimeSpecOrBuilder	getResourceRuntimeSpecOrBuilder() Optional.
boolean	getSatisfiesPzi() Output only.
boolean	getSatisfiesPzs() Output only.
com.google.protobuf.Timestamp	getStartTime() Output only.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Output only.
PersistentResource.State	getState() Output only.
int	getStateValue() Output only.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasEncryptionSpec() Optional.
boolean	hasError() Output only.
boolean	hasPscInterfaceConfig() Optional.
boolean	hasResourceRuntime() Output only.
boolean	hasResourceRuntimeSpec() Optional.
boolean	hasStartTime() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Immutable. Resource name of a PersistentResource.
 

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Immutable. Resource name of a PersistentResource.
 

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The bytes for name.

getDisplayName

String getDisplayName()

 Optional. The display name of the PersistentResource.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
 

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 Optional. The display name of the PersistentResource.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
 

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for displayName.

getResourcePoolsList

List<ResourcePool> getResourcePoolsList()

 Required. The spec of the pools of different resources.
 

repeated .google.cloud.aiplatform.v1beta1.ResourcePool resource_pools = 4 [(.google.api.field_behavior) = REQUIRED];

getResourcePools

ResourcePool getResourcePools(int index)

 Required. The spec of the pools of different resources.
 

repeated .google.cloud.aiplatform.v1beta1.ResourcePool resource_pools = 4 [(.google.api.field_behavior) = REQUIRED];

getResourcePoolsCount

int getResourcePoolsCount()

 Required. The spec of the pools of different resources.
 

repeated .google.cloud.aiplatform.v1beta1.ResourcePool resource_pools = 4 [(.google.api.field_behavior) = REQUIRED];

getResourcePoolsOrBuilderList

List<? extends ResourcePoolOrBuilder> getResourcePoolsOrBuilderList()

 Required. The spec of the pools of different resources.
 

repeated .google.cloud.aiplatform.v1beta1.ResourcePool resource_pools = 4 [(.google.api.field_behavior) = REQUIRED];

getResourcePoolsOrBuilder

ResourcePoolOrBuilder getResourcePoolsOrBuilder(int index)

 Required. The spec of the pools of different resources.
 

repeated .google.cloud.aiplatform.v1beta1.ResourcePool resource_pools = 4 [(.google.api.field_behavior) = REQUIRED];

getStateValue

int getStateValue()

 Output only. The detailed state of a Study.
 

.google.cloud.aiplatform.v1beta1.PersistentResource.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for state.

getState

PersistentResource.State getState()

 Output only. The detailed state of a Study.
 

.google.cloud.aiplatform.v1beta1.PersistentResource.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The state.

hasError

boolean hasError()

 Output only. Only populated when persistent resource's state is `STOPPING`
 or `ERROR`.
 

.google.rpc.Status error = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the error field is set.

getError

com.google.rpc.Status getError()

 Output only. Only populated when persistent resource's state is `STOPPING`
 or `ERROR`.
 

.google.rpc.Status error = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The error.

getErrorOrBuilder

com.google.rpc.StatusOrBuilder getErrorOrBuilder()

 Output only. Only populated when persistent resource's state is `STOPPING`
 or `ERROR`.
 

.google.rpc.Status error = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasCreateTime

boolean hasCreateTime()

 Output only. Time when the PersistentResource was created.
 

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Time when the PersistentResource was created.
 

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Time when the PersistentResource was created.
 

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasStartTime

boolean hasStartTime()

 Output only. Time when the PersistentResource for the first time entered
 the `RUNNING` state.
 

.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the startTime field is set.

getStartTime

com.google.protobuf.Timestamp getStartTime()

 Output only. Time when the PersistentResource for the first time entered
 the `RUNNING` state.
 

.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 Output only. Time when the PersistentResource for the first time entered
 the `RUNNING` state.
 

.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasUpdateTime

boolean hasUpdateTime()

 Output only. Time when the PersistentResource was most recently updated.
 

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Output only. Time when the PersistentResource was most recently updated.
 

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Time when the PersistentResource was most recently updated.
 

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getLabelsCount

int getLabelsCount()

 Optional. The labels with user-defined metadata to organize
 PersistentResource.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
 

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

containsLabels

boolean containsLabels(String key)

 Optional. The labels with user-defined metadata to organize
 PersistentResource.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
 

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

 Optional. The labels with user-defined metadata to organize
 PersistentResource.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
 

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          String defaultValue)

 Optional. The labels with user-defined metadata to organize
 PersistentResource.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
 

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrThrow

String getLabelsOrThrow(String key)

 Optional. The labels with user-defined metadata to organize
 PersistentResource.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
 

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

getNetwork

String getNetwork()

 Optional. The full name of the Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to peered with
 Vertex AI to host the persistent resources.
 For example, `projects/12345/global/networks/myVPC`.
 [Format](/compute/docs/reference/rest/v1/networks/insert)
 is of the form `projects/{project}/global/networks/{network}`.
 Where {project} is a project number, as in `12345`, and {network} is a
 network name.

 To specify this field, you must have already [configured VPC Network
 Peering for Vertex
 AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).

 If this field is left unspecified, the resources aren't peered with any
 network.
 

string network = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns:

The network.

getNetworkBytes

com.google.protobuf.ByteString getNetworkBytes()

 Optional. The full name of the Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to peered with
 Vertex AI to host the persistent resources.
 For example, `projects/12345/global/networks/myVPC`.
 [Format](/compute/docs/reference/rest/v1/networks/insert)
 is of the form `projects/{project}/global/networks/{network}`.
 Where {project} is a project number, as in `12345`, and {network} is a
 network name.

 To specify this field, you must have already [configured VPC Network
 Peering for Vertex
 AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).

 If this field is left unspecified, the resources aren't peered with any
 network.
 

string network = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns:

The bytes for network.

hasPscInterfaceConfig

boolean hasPscInterfaceConfig()

 Optional. Configuration for PSC-I for PersistentResource.
 

.google.cloud.aiplatform.v1beta1.PscInterfaceConfig psc_interface_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the pscInterfaceConfig field is set.

getPscInterfaceConfig

PscInterfaceConfig getPscInterfaceConfig()

 Optional. Configuration for PSC-I for PersistentResource.
 

.google.cloud.aiplatform.v1beta1.PscInterfaceConfig psc_interface_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pscInterfaceConfig.

getPscInterfaceConfigOrBuilder

PscInterfaceConfigOrBuilder getPscInterfaceConfigOrBuilder()

 Optional. Configuration for PSC-I for PersistentResource.
 

.google.cloud.aiplatform.v1beta1.PscInterfaceConfig psc_interface_config = 17 [(.google.api.field_behavior) = OPTIONAL];

hasEncryptionSpec

boolean hasEncryptionSpec()

 Optional. Customer-managed encryption key spec for a PersistentResource.
 If set, this PersistentResource and all sub-resources of this
 PersistentResource will be secured by this key.
 

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the encryptionSpec field is set.

getEncryptionSpec

EncryptionSpec getEncryptionSpec()

 Optional. Customer-managed encryption key spec for a PersistentResource.
 If set, this PersistentResource and all sub-resources of this
 PersistentResource will be secured by this key.
 

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The encryptionSpec.

getEncryptionSpecOrBuilder

EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

 Optional. Customer-managed encryption key spec for a PersistentResource.
 If set, this PersistentResource and all sub-resources of this
 PersistentResource will be secured by this key.
 

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 12 [(.google.api.field_behavior) = OPTIONAL];

hasResourceRuntimeSpec

boolean hasResourceRuntimeSpec()

 Optional. Persistent Resource runtime spec.
 For example, used for Ray cluster configuration.
 

.google.cloud.aiplatform.v1beta1.ResourceRuntimeSpec resource_runtime_spec = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the resourceRuntimeSpec field is set.

getResourceRuntimeSpec

ResourceRuntimeSpec getResourceRuntimeSpec()

 Optional. Persistent Resource runtime spec.
 For example, used for Ray cluster configuration.
 

.google.cloud.aiplatform.v1beta1.ResourceRuntimeSpec resource_runtime_spec = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The resourceRuntimeSpec.

getResourceRuntimeSpecOrBuilder

ResourceRuntimeSpecOrBuilder getResourceRuntimeSpecOrBuilder()

 Optional. Persistent Resource runtime spec.
 For example, used for Ray cluster configuration.
 

.google.cloud.aiplatform.v1beta1.ResourceRuntimeSpec resource_runtime_spec = 13 [(.google.api.field_behavior) = OPTIONAL];

hasResourceRuntime

boolean hasResourceRuntime()

 Output only. Runtime information of the Persistent Resource.
 

.google.cloud.aiplatform.v1beta1.ResourceRuntime resource_runtime = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the resourceRuntime field is set.

getResourceRuntime

ResourceRuntime getResourceRuntime()

 Output only. Runtime information of the Persistent Resource.
 

.google.cloud.aiplatform.v1beta1.ResourceRuntime resource_runtime = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The resourceRuntime.

getResourceRuntimeOrBuilder

ResourceRuntimeOrBuilder getResourceRuntimeOrBuilder()

 Output only. Runtime information of the Persistent Resource.
 

.google.cloud.aiplatform.v1beta1.ResourceRuntime resource_runtime = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

getReservedIpRangesList

List<String> getReservedIpRangesList()

 Optional. A list of names for the reserved IP ranges under the VPC network
 that can be used for this persistent resource.

 If set, we will deploy the persistent resource within the provided IP
 ranges. Otherwise, the persistent resource is deployed to any IP
 ranges under the provided VPC network.

 Example: ['vertex-ai-ip-range'].
 

repeated string reserved_ip_ranges = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns:

A list containing the reservedIpRanges.

getReservedIpRangesCount

int getReservedIpRangesCount()

 Optional. A list of names for the reserved IP ranges under the VPC network
 that can be used for this persistent resource.

 If set, we will deploy the persistent resource within the provided IP
 ranges. Otherwise, the persistent resource is deployed to any IP
 ranges under the provided VPC network.

 Example: ['vertex-ai-ip-range'].
 

repeated string reserved_ip_ranges = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The count of reservedIpRanges.

getReservedIpRanges

String getReservedIpRanges(int index)

 Optional. A list of names for the reserved IP ranges under the VPC network
 that can be used for this persistent resource.

 If set, we will deploy the persistent resource within the provided IP
 ranges. Otherwise, the persistent resource is deployed to any IP
 ranges under the provided VPC network.

 Example: ['vertex-ai-ip-range'].
 

repeated string reserved_ip_ranges = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the element to return.

Returns:

The reservedIpRanges at the given index.

getReservedIpRangesBytes

com.google.protobuf.ByteString getReservedIpRangesBytes(int index)

 Optional. A list of names for the reserved IP ranges under the VPC network
 that can be used for this persistent resource.

 If set, we will deploy the persistent resource within the provided IP
 ranges. Otherwise, the persistent resource is deployed to any IP
 ranges under the provided VPC network.

 Example: ['vertex-ai-ip-range'].
 

repeated string reserved_ip_ranges = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the reservedIpRanges at the given index.

getSatisfiesPzs

boolean getSatisfiesPzs()

 Output only. Reserved for future use.
 

bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The satisfiesPzs.

getSatisfiesPzi

boolean getSatisfiesPzi()

 Output only. Reserved for future use.
 

bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The satisfiesPzi.