Class PersistentResource.Builder (3.32.0)

public static final class PersistentResource.Builder extends GeneratedMessageV3.Builder<PersistentResource.Builder> implements PersistentResourceOrBuilder

Represents long-lasting resources that are dedicated to users to runs custom workloads. A PersistentResource can have multiple node pools and each node pool can have its own machine spec.

Protobuf type google.cloud.aiplatform.v1beta1.PersistentResource

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PersistentResource.Builder

Implements

PersistentResourceOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllReservedIpRanges(Iterable<String> values)

public PersistentResource.Builder addAllReservedIpRanges(Iterable<String> values)

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
`values`	`Iterable<String>` The reservedIpRanges to add.

Returns
Type	Description
`PersistentResource.Builder`	This builder for chaining.

addAllResourcePools(Iterable<? extends ResourcePool> values)

public PersistentResource.Builder addAllResourcePools(Iterable<? extends ResourcePool> values)

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
`values`	`Iterable<? extends com.google.cloud.aiplatform.v1beta1.ResourcePool>`

Returns
Type	Description
`PersistentResource.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PersistentResource.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`PersistentResource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addReservedIpRanges(String value)

public PersistentResource.Builder addReservedIpRanges(String value)

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
`value`	`String` The reservedIpRanges to add.

Returns
Type	Description
`PersistentResource.Builder`	This builder for chaining.

addReservedIpRangesBytes(ByteString value)

public PersistentResource.Builder addReservedIpRangesBytes(ByteString value)

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
`value`	`ByteString` The bytes of the reservedIpRanges to add.

Returns
Type	Description
`PersistentResource.Builder`	This builder for chaining.

addResourcePools(ResourcePool value)

public PersistentResource.Builder addResourcePools(ResourcePool value)

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
`value`	`ResourcePool`

Returns
Type	Description
`PersistentResource.Builder`

addResourcePools(ResourcePool.Builder builderForValue)

public PersistentResource.Builder addResourcePools(ResourcePool.Builder builderForValue)

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
`builderForValue`	`ResourcePool.Builder`

Returns
Type	Description
`PersistentResource.Builder`

addResourcePools(int index, ResourcePool value)

public PersistentResource.Builder addResourcePools(int index, ResourcePool value)

Required. The spec of the pools of different resources.

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

Parameters
Name	Description
`index`	`int`
`value`	`ResourcePool`

Returns
Type	Description
`PersistentResource.Builder`

addResourcePools(int index, ResourcePool.Builder builderForValue)

public PersistentResource.Builder addResourcePools(int index, ResourcePool.Builder builderForValue)

Required. The spec of the pools of different resources.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ResourcePool.Builder`

Returns
Type	Description
`PersistentResource.Builder`

addResourcePoolsBuilder()

public ResourcePool.Builder addResourcePoolsBuilder()

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
`ResourcePool.Builder`

addResourcePoolsBuilder(int index)

public ResourcePool.Builder addResourcePoolsBuilder(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.Builder`

build()

public PersistentResource build()

Returns
Type	Description
`PersistentResource`

buildPartial()

public PersistentResource buildPartial()

Returns
Type	Description
`PersistentResource`

clear()

public PersistentResource.Builder clear()

Returns
Type	Description
`PersistentResource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCreateTime()

public PersistentResource.Builder clearCreateTime()

Output only. Time when the PersistentResource was created.

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

Returns
Type	Description
`PersistentResource.Builder`

clearDisplayName()

public PersistentResource.Builder clearDisplayName()

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
`PersistentResource.Builder`	This builder for chaining.

clearEncryptionSpec()

public PersistentResource.Builder clearEncryptionSpec()

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
`PersistentResource.Builder`

clearError()

public PersistentResource.Builder clearError()

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
`PersistentResource.Builder`

clearField(Descriptors.FieldDescriptor field)

public PersistentResource.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`PersistentResource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLabels()

public PersistentResource.Builder clearLabels()

Returns
Type	Description
`PersistentResource.Builder`

clearName()

public PersistentResource.Builder clearName()

Immutable. Resource name of a PersistentResource.

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

Returns
Type	Description
`PersistentResource.Builder`	This builder for chaining.

clearNetwork()

public PersistentResource.Builder clearNetwork()

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
`PersistentResource.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PersistentResource.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`PersistentResource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearReservedIpRanges()

public PersistentResource.Builder clearReservedIpRanges()

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
`PersistentResource.Builder`	This builder for chaining.

clearResourcePools()

public PersistentResource.Builder clearResourcePools()

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
`PersistentResource.Builder`

clearResourceRuntime()

public PersistentResource.Builder clearResourceRuntime()

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
`PersistentResource.Builder`

clearResourceRuntimeSpec()

public PersistentResource.Builder clearResourceRuntimeSpec()

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
`PersistentResource.Builder`

clearStartTime()

public PersistentResource.Builder clearStartTime()

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
`PersistentResource.Builder`

clearState()

public PersistentResource.Builder clearState()

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.Builder`	This builder for chaining.

clearUpdateTime()

public PersistentResource.Builder clearUpdateTime()

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
`PersistentResource.Builder`

clone()

public PersistentResource.Builder clone()

Returns
Type	Description
`PersistentResource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsLabels(String key)

public 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 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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time when the PersistentResource was created.

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

Returns
Type	Description
`Builder`

getCreateTimeOrBuilder()

public 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`

getDefaultInstanceForType()

public PersistentResource getDefaultInstanceForType()

Returns
Type	Description
`PersistentResource`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public 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 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 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.

getEncryptionSpecBuilder()

public EncryptionSpec.Builder getEncryptionSpecBuilder()

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.Builder`

getEncryptionSpecOrBuilder()

public 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 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.

getErrorBuilder()

public Status.Builder getErrorBuilder()

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.Builder`

getErrorOrBuilder()

public 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public 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 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 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 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`

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,String>`

getName()

public String getName()

Immutable. Resource name of a PersistentResource.

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

Returns
Type	Description
`String`	The name.

getNameBytes()

public 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 String getNetwork()

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 ByteString getNetworkBytes()

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.

getReservedIpRanges(int index)

public 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`	`int` The index of the element to return.

Returns
Type	Description
`String`	The reservedIpRanges at the given index.

getReservedIpRangesBytes(int index)

public 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`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the reservedIpRanges at the given index.

getReservedIpRangesCount()

public 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 ProtocolStringList 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
`ProtocolStringList`	A list containing the reservedIpRanges.

getResourcePools(int index)

public 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`

getResourcePoolsBuilder(int index)

public ResourcePool.Builder getResourcePoolsBuilder(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.Builder`

getResourcePoolsBuilderList()

public List<ResourcePool.Builder> getResourcePoolsBuilderList()

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<Builder>`

getResourcePoolsCount()

public 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 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 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 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 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.

getResourceRuntimeBuilder()

public ResourceRuntime.Builder getResourceRuntimeBuilder()

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.Builder`

getResourceRuntimeOrBuilder()

public 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 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.

getResourceRuntimeSpecBuilder()

public ResourceRuntimeSpec.Builder getResourceRuntimeSpecBuilder()

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.Builder`

getResourceRuntimeSpecOrBuilder()

public 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`

getStartTime()

public 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.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

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
`Builder`

getStartTimeOrBuilder()

public 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 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 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 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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
`Builder`

getUpdateTimeOrBuilder()

public 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 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 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 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.

hasResourceRuntime()

public 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public PersistentResource.Builder mergeCreateTime(Timestamp value)

Output only. Time when the PersistentResource was created.

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`PersistentResource.Builder`

mergeEncryptionSpec(EncryptionSpec value)

public PersistentResource.Builder mergeEncryptionSpec(EncryptionSpec value)

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];

Parameter
Name	Description
`value`	`EncryptionSpec`

Returns
Type	Description
`PersistentResource.Builder`

mergeError(Status value)

public PersistentResource.Builder mergeError(Status value)

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

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

Parameter
Name	Description
`value`	`com.google.rpc.Status`

Returns
Type	Description
`PersistentResource.Builder`

mergeFrom(PersistentResource other)

public PersistentResource.Builder mergeFrom(PersistentResource other)

Parameter
Name	Description
`other`	`PersistentResource`

Returns
Type	Description
`PersistentResource.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PersistentResource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PersistentResource.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public PersistentResource.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`PersistentResource.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeResourceRuntime(ResourceRuntime value)

public PersistentResource.Builder mergeResourceRuntime(ResourceRuntime value)

Output only. Runtime information of the Persistent Resource.

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

Parameter
Name	Description
`value`	`ResourceRuntime`

Returns
Type	Description
`PersistentResource.Builder`

mergeResourceRuntimeSpec(ResourceRuntimeSpec value)

public PersistentResource.Builder mergeResourceRuntimeSpec(ResourceRuntimeSpec value)

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];

Parameter
Name	Description
`value`	`ResourceRuntimeSpec`

Returns
Type	Description
`PersistentResource.Builder`

mergeStartTime(Timestamp value)

public PersistentResource.Builder mergeStartTime(Timestamp value)

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];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`PersistentResource.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PersistentResource.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`PersistentResource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public PersistentResource.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`PersistentResource.Builder`

putAllLabels(Map<String,String> values)

public PersistentResource.Builder putAllLabels(Map<String,String> values)

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
`values`	`Map<String,String>`

Returns
Type	Description
`PersistentResource.Builder`

putLabels(String key, String value)

public PersistentResource.Builder putLabels(String key, String value)

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`
`value`	`String`

Returns
Type	Description
`PersistentResource.Builder`

removeLabels(String key)

public PersistentResource.Builder removeLabels(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
`PersistentResource.Builder`

removeResourcePools(int index)

public PersistentResource.Builder removeResourcePools(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
`PersistentResource.Builder`

setCreateTime(Timestamp value)

public PersistentResource.Builder setCreateTime(Timestamp value)

Output only. Time when the PersistentResource was created.

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`PersistentResource.Builder`

setCreateTime(Timestamp.Builder builderForValue)

public PersistentResource.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time when the PersistentResource was created.

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

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`PersistentResource.Builder`

setDisplayName(String value)

public PersistentResource.Builder setDisplayName(String value)

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];

Parameter
Name	Description
`value`	`String` The displayName to set.

Returns
Type	Description
`PersistentResource.Builder`	This builder for chaining.

setDisplayNameBytes(ByteString value)

public PersistentResource.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name	Description
`value`	`ByteString` The bytes for displayName to set.

Returns
Type	Description
`PersistentResource.Builder`	This builder for chaining.

setEncryptionSpec(EncryptionSpec value)

public PersistentResource.Builder setEncryptionSpec(EncryptionSpec value)

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];

Parameter
Name	Description
`value`	`EncryptionSpec`

Returns
Type	Description
`PersistentResource.Builder`

setEncryptionSpec(EncryptionSpec.Builder builderForValue)

public PersistentResource.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)

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];

Parameter
Name	Description
`builderForValue`	`EncryptionSpec.Builder`

Returns
Type	Description
`PersistentResource.Builder`

setError(Status value)

public PersistentResource.Builder setError(Status value)

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

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

Parameter
Name	Description
`value`	`com.google.rpc.Status`

Returns
Type	Description
`PersistentResource.Builder`

setError(Status.Builder builderForValue)

public PersistentResource.Builder setError(Status.Builder builderForValue)

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

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

Parameter
Name	Description
`builderForValue`	`com.google.rpc.Status.Builder`

Returns
Type	Description
`PersistentResource.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public PersistentResource.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`PersistentResource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public PersistentResource.Builder setName(String value)

Immutable. Resource name of a PersistentResource.

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

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`PersistentResource.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public PersistentResource.Builder setNameBytes(ByteString value)

Immutable. Resource name of a PersistentResource.

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

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`PersistentResource.Builder`	This builder for chaining.

setNetwork(String value)

public PersistentResource.Builder setNetwork(String value)

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) = { ... }

Parameter
Name	Description
`value`	`String` The network to set.

Returns
Type	Description
`PersistentResource.Builder`	This builder for chaining.

setNetworkBytes(ByteString value)

public PersistentResource.Builder setNetworkBytes(ByteString value)

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) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for network to set.

Returns
Type	Description
`PersistentResource.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PersistentResource.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`PersistentResource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setReservedIpRanges(int index, String value)

public PersistentResource.Builder setReservedIpRanges(int index, String value)

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
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The reservedIpRanges to set.

Returns
Type	Description
`PersistentResource.Builder`	This builder for chaining.

setResourcePools(int index, ResourcePool value)

public PersistentResource.Builder setResourcePools(int index, ResourcePool value)

Required. The spec of the pools of different resources.

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

Parameters
Name	Description
`index`	`int`
`value`	`ResourcePool`

Returns
Type	Description
`PersistentResource.Builder`

setResourcePools(int index, ResourcePool.Builder builderForValue)

public PersistentResource.Builder setResourcePools(int index, ResourcePool.Builder builderForValue)

Required. The spec of the pools of different resources.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ResourcePool.Builder`

Returns
Type	Description
`PersistentResource.Builder`

setResourceRuntime(ResourceRuntime value)

public PersistentResource.Builder setResourceRuntime(ResourceRuntime value)

Output only. Runtime information of the Persistent Resource.

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

Parameter
Name	Description
`value`	`ResourceRuntime`

Returns
Type	Description
`PersistentResource.Builder`

setResourceRuntime(ResourceRuntime.Builder builderForValue)

public PersistentResource.Builder setResourceRuntime(ResourceRuntime.Builder builderForValue)

Output only. Runtime information of the Persistent Resource.

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

Parameter
Name	Description
`builderForValue`	`ResourceRuntime.Builder`

Returns
Type	Description
`PersistentResource.Builder`

setResourceRuntimeSpec(ResourceRuntimeSpec value)

public PersistentResource.Builder setResourceRuntimeSpec(ResourceRuntimeSpec value)

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];

Parameter
Name	Description
`value`	`ResourceRuntimeSpec`

Returns
Type	Description
`PersistentResource.Builder`

setResourceRuntimeSpec(ResourceRuntimeSpec.Builder builderForValue)

public PersistentResource.Builder setResourceRuntimeSpec(ResourceRuntimeSpec.Builder builderForValue)

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];

Parameter
Name	Description
`builderForValue`	`ResourceRuntimeSpec.Builder`

Returns
Type	Description
`PersistentResource.Builder`

setStartTime(Timestamp value)

public PersistentResource.Builder setStartTime(Timestamp value)

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];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`PersistentResource.Builder`

setStartTime(Timestamp.Builder builderForValue)

public PersistentResource.Builder setStartTime(Timestamp.Builder builderForValue)

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];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`PersistentResource.Builder`

setState(PersistentResource.State value)

public PersistentResource.Builder setState(PersistentResource.State value)

Output only. The detailed state of a Study.

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

Parameter
Name	Description
`value`	`PersistentResource.State` The state to set.

Returns
Type	Description
`PersistentResource.Builder`	This builder for chaining.

setStateValue(int value)

public PersistentResource.Builder setStateValue(int value)

Output only. The detailed state of a Study.

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for state to set.

Returns
Type	Description
`PersistentResource.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PersistentResource.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`PersistentResource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public PersistentResource.Builder setUpdateTime(Timestamp value)

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

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`PersistentResource.Builder`

setUpdateTime(Timestamp.Builder builderForValue)

public PersistentResource.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`PersistentResource.Builder`