Class PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder (3.56.0)

public static final class PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder extends GeneratedMessageV3.Builder<PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder> implements PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetailOrBuilder

Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview

Protobuf type google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder
Overrides

build()

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail build()
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail

buildPartial()

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail buildPartial()
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail

clear()

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder clear()
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder
Overrides

clearPersistentResourceName()

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder clearPersistentResourceName()

Persistent resource name. Format: projects/{project}/locations/{location}/persistentResources/{persistent_resource}

string persistent_resource_name = 1;

Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder

This builder for chaining.

clearTaskResourceUnavailableTimeoutBehavior()

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder clearTaskResourceUnavailableTimeoutBehavior()

Specifies the behavior to take if the timeout is reached.

.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.TaskResourceUnavailableTimeoutBehavior task_resource_unavailable_timeout_behavior = 3;

Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder

This builder for chaining.

clearTaskResourceUnavailableWaitTimeMs()

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder clearTaskResourceUnavailableWaitTimeMs()

The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.

int64 task_resource_unavailable_wait_time_ms = 2;

Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder

This builder for chaining.

clone()

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder clone()
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder
Overrides

getDefaultInstanceForType()

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail getDefaultInstanceForType()
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPersistentResourceName()

public String getPersistentResourceName()

Persistent resource name. Format: projects/{project}/locations/{location}/persistentResources/{persistent_resource}

string persistent_resource_name = 1;

Returns
Type Description
String

The persistentResourceName.

getPersistentResourceNameBytes()

public ByteString getPersistentResourceNameBytes()

Persistent resource name. Format: projects/{project}/locations/{location}/persistentResources/{persistent_resource}

string persistent_resource_name = 1;

Returns
Type Description
ByteString

The bytes for persistentResourceName.

getTaskResourceUnavailableTimeoutBehavior()

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.TaskResourceUnavailableTimeoutBehavior getTaskResourceUnavailableTimeoutBehavior()

Specifies the behavior to take if the timeout is reached.

.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.TaskResourceUnavailableTimeoutBehavior task_resource_unavailable_timeout_behavior = 3;

Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.TaskResourceUnavailableTimeoutBehavior

The taskResourceUnavailableTimeoutBehavior.

getTaskResourceUnavailableTimeoutBehaviorValue()

public int getTaskResourceUnavailableTimeoutBehaviorValue()

Specifies the behavior to take if the timeout is reached.

.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.TaskResourceUnavailableTimeoutBehavior task_resource_unavailable_timeout_behavior = 3;

Returns
Type Description
int

The enum numeric value on the wire for taskResourceUnavailableTimeoutBehavior.

getTaskResourceUnavailableWaitTimeMs()

public long getTaskResourceUnavailableWaitTimeMs()

The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.

int64 task_resource_unavailable_wait_time_ms = 2;

Returns
Type Description
long

The taskResourceUnavailableWaitTimeMs.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail other)

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder mergeFrom(PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail other)
Parameter
Name Description
other PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder
Overrides

setPersistentResourceName(String value)

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder setPersistentResourceName(String value)

Persistent resource name. Format: projects/{project}/locations/{location}/persistentResources/{persistent_resource}

string persistent_resource_name = 1;

Parameter
Name Description
value String

The persistentResourceName to set.

Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder

This builder for chaining.

setPersistentResourceNameBytes(ByteString value)

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder setPersistentResourceNameBytes(ByteString value)

Persistent resource name. Format: projects/{project}/locations/{location}/persistentResources/{persistent_resource}

string persistent_resource_name = 1;

Parameter
Name Description
value ByteString

The bytes for persistentResourceName to set.

Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder

This builder for chaining.

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

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder
Overrides

setTaskResourceUnavailableTimeoutBehavior(PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.TaskResourceUnavailableTimeoutBehavior value)

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder setTaskResourceUnavailableTimeoutBehavior(PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.TaskResourceUnavailableTimeoutBehavior value)

Specifies the behavior to take if the timeout is reached.

.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.TaskResourceUnavailableTimeoutBehavior task_resource_unavailable_timeout_behavior = 3;

Parameter
Name Description
value PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.TaskResourceUnavailableTimeoutBehavior

The taskResourceUnavailableTimeoutBehavior to set.

Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder

This builder for chaining.

setTaskResourceUnavailableTimeoutBehaviorValue(int value)

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder setTaskResourceUnavailableTimeoutBehaviorValue(int value)

Specifies the behavior to take if the timeout is reached.

.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.TaskResourceUnavailableTimeoutBehavior task_resource_unavailable_timeout_behavior = 3;

Parameter
Name Description
value int

The enum numeric value on the wire for taskResourceUnavailableTimeoutBehavior to set.

Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder

This builder for chaining.

setTaskResourceUnavailableWaitTimeMs(long value)

public PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder setTaskResourceUnavailableWaitTimeMs(long value)

The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.

int64 task_resource_unavailable_wait_time_ms = 2;

Parameter
Name Description
value long

The taskResourceUnavailableWaitTimeMs to set.

Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PipelineJob.RuntimeConfig.PersistentResourceRuntimeDetail.Builder
Overrides