- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public interface PersistentResourceOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getCreateTime()
public abstract Timestamp getCreateTime()Output only. Time when the PersistentResource was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Time when the PersistentResource was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDisplayName()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEncryptionSpec()
public abstract 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 | |
|---|---|
| Type | Description |
EncryptionSpec |
The encryptionSpec. |
getEncryptionSpecOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
EncryptionSpecOrBuilder |
|
getError()
public abstract 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 | |
|---|---|
| Type | Description |
com.google.rpc.Status |
The error. |
getErrorOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder |
|
getLabels() (deprecated)
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public abstract 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];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getName()
public abstract String getName()Immutable. Resource name of a PersistentResource.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()Immutable. Resource name of a PersistentResource.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getNetwork()
public abstract String getNetwork() Optional. The full name of the Compute Engine
network to peered with
Vertex AI to host the persistent resources.
For example, projects/12345/global/networks/myVPC.
Format
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.
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 | |
|---|---|
| Type | Description |
String |
The network. |
getNetworkBytes()
public abstract ByteString getNetworkBytes() Optional. The full name of the Compute Engine
network to peered with
Vertex AI to host the persistent resources.
For example, projects/12345/global/networks/myVPC.
Format
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.
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for network. |
getPscInterfaceConfig()
public abstract PscInterfaceConfig getPscInterfaceConfig()Optional. Configuration for PSC-I for PersistentResource.
.google.cloud.aiplatform.v1beta1.PscInterfaceConfig psc_interface_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PscInterfaceConfig |
The pscInterfaceConfig. |
getPscInterfaceConfigOrBuilder()
public abstract PscInterfaceConfigOrBuilder getPscInterfaceConfigOrBuilder()Optional. Configuration for PSC-I for PersistentResource.
.google.cloud.aiplatform.v1beta1.PscInterfaceConfig psc_interface_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PscInterfaceConfigOrBuilder |
|
getReservedIpRanges(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The reservedIpRanges at the given index. |
getReservedIpRangesBytes(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the reservedIpRanges at the given index. |
getReservedIpRangesCount()
public abstract 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 | |
|---|---|
| Type | Description |
int |
The count of reservedIpRanges. |
getReservedIpRangesList()
public abstract 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 | |
|---|---|
| Type | Description |
List<String> |
A list containing the reservedIpRanges. |
getResourcePools(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ResourcePool |
|
getResourcePoolsCount()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
int |
|
getResourcePoolsList()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
List<ResourcePool> |
|
getResourcePoolsOrBuilder(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ResourcePoolOrBuilder |
|
getResourcePoolsOrBuilderList()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.ResourcePoolOrBuilder> |
|
getResourceRuntime()
public abstract 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 | |
|---|---|
| Type | Description |
ResourceRuntime |
The resourceRuntime. |
getResourceRuntimeOrBuilder()
public abstract ResourceRuntimeOrBuilder getResourceRuntimeOrBuilder()Output only. Runtime information of the Persistent Resource.
.google.cloud.aiplatform.v1beta1.ResourceRuntime resource_runtime = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ResourceRuntimeOrBuilder |
|
getResourceRuntimeSpec()
public abstract 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 | |
|---|---|
| Type | Description |
ResourceRuntimeSpec |
The resourceRuntimeSpec. |
getResourceRuntimeSpecOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
ResourceRuntimeSpecOrBuilder |
|
getSatisfiesPzi()
public abstract boolean getSatisfiesPzi()Output only. Reserved for future use.
bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The satisfiesPzi. |
getSatisfiesPzs()
public abstract boolean getSatisfiesPzs()Output only. Reserved for future use.
bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The satisfiesPzs. |
getStartTime()
public abstract 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 | |
|---|---|
| Type | Description |
Timestamp |
The startTime. |
getStartTimeOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getState()
public abstract 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 | |
|---|---|
| Type | Description |
PersistentResource.State |
The state. |
getStateValue()
public abstract 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 | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getUpdateTime()
public abstract 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 | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Time when the PersistentResource was most recently updated.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasCreateTime()
public abstract boolean hasCreateTime()Output only. Time when the PersistentResource was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasEncryptionSpec()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the encryptionSpec field is set. |
hasError()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the error field is set. |
hasPscInterfaceConfig()
public abstract boolean hasPscInterfaceConfig()Optional. Configuration for PSC-I for PersistentResource.
.google.cloud.aiplatform.v1beta1.PscInterfaceConfig psc_interface_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pscInterfaceConfig field is set. |
hasResourceRuntime()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the resourceRuntime field is set. |
hasResourceRuntimeSpec()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the resourceRuntimeSpec field is set. |
hasStartTime()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the startTime field is set. |
hasUpdateTime()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |