Class BatchCancelPipelineJobsRequest.Builder (3.47.0)

public static final class BatchCancelPipelineJobsRequest.Builder extends GeneratedMessageV3.Builder<BatchCancelPipelineJobsRequest.Builder> implements BatchCancelPipelineJobsRequestOrBuilder

Request message for PipelineService.BatchCancelPipelineJobs.

Protobuf type google.cloud.aiplatform.v1.BatchCancelPipelineJobsRequest

Static Methods

getDescriptor()

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

Methods

addAllNames(Iterable<String> values)

public BatchCancelPipelineJobsRequest.Builder addAllNames(Iterable<String> values)

Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The names to add.

Returns
Type Description
BatchCancelPipelineJobsRequest.Builder

This builder for chaining.

addNames(String value)

public BatchCancelPipelineJobsRequest.Builder addNames(String value)

Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The names to add.

Returns
Type Description
BatchCancelPipelineJobsRequest.Builder

This builder for chaining.

addNamesBytes(ByteString value)

public BatchCancelPipelineJobsRequest.Builder addNamesBytes(ByteString value)

Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the names to add.

Returns
Type Description
BatchCancelPipelineJobsRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public BatchCancelPipelineJobsRequest build()
Returns
Type Description
BatchCancelPipelineJobsRequest

buildPartial()

public BatchCancelPipelineJobsRequest buildPartial()
Returns
Type Description
BatchCancelPipelineJobsRequest

clear()

public BatchCancelPipelineJobsRequest.Builder clear()
Returns
Type Description
BatchCancelPipelineJobsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public BatchCancelPipelineJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BatchCancelPipelineJobsRequest.Builder
Overrides

clearNames()

public BatchCancelPipelineJobsRequest.Builder clearNames()

Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
BatchCancelPipelineJobsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchCancelPipelineJobsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BatchCancelPipelineJobsRequest.Builder
Overrides

clearParent()

public BatchCancelPipelineJobsRequest.Builder clearParent()

Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
BatchCancelPipelineJobsRequest.Builder

This builder for chaining.

clone()

public BatchCancelPipelineJobsRequest.Builder clone()
Returns
Type Description
BatchCancelPipelineJobsRequest.Builder
Overrides

getDefaultInstanceForType()

public BatchCancelPipelineJobsRequest getDefaultInstanceForType()
Returns
Type Description
BatchCancelPipelineJobsRequest

getDescriptorForType()

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

getNames(int index)

public String getNames(int index)

Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The names at the given index.

getNamesBytes(int index)

public ByteString getNamesBytes(int index)

Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the names at the given index.

getNamesCount()

public int getNamesCount()

Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of names.

getNamesList()

public ProtocolStringList getNamesList()

Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the names.

getParent()

public String getParent()

Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BatchCancelPipelineJobsRequest other)

public BatchCancelPipelineJobsRequest.Builder mergeFrom(BatchCancelPipelineJobsRequest other)
Parameter
Name Description
other BatchCancelPipelineJobsRequest
Returns
Type Description
BatchCancelPipelineJobsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public BatchCancelPipelineJobsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BatchCancelPipelineJobsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchCancelPipelineJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchCancelPipelineJobsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

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

setNames(int index, String value)

public BatchCancelPipelineJobsRequest.Builder setNames(int index, String value)

Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The names to set.

Returns
Type Description
BatchCancelPipelineJobsRequest.Builder

This builder for chaining.

setParent(String value)

public BatchCancelPipelineJobsRequest.Builder setParent(String value)

Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
BatchCancelPipelineJobsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public BatchCancelPipelineJobsRequest.Builder setParentBytes(ByteString value)

Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
BatchCancelPipelineJobsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchCancelPipelineJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchCancelPipelineJobsRequest.Builder
Overrides