Class TerminateJobRunRequest.Builder (1.81.0)

public static final class TerminateJobRunRequest.Builder extends GeneratedMessage.Builder<TerminateJobRunRequest.Builder> implements TerminateJobRunRequestOrBuilder

The request object used by TerminateJobRun.

Protobuf type google.cloud.deploy.v1.TerminateJobRunRequest

Static Methods

getDescriptor()

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

Methods

addAllOverrideDeployPolicy(Iterable<String> values)

public TerminateJobRunRequest.Builder addAllOverrideDeployPolicy(Iterable<String> values)

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The overrideDeployPolicy to add.

Returns
Type Description
TerminateJobRunRequest.Builder

This builder for chaining.

addOverrideDeployPolicy(String value)

public TerminateJobRunRequest.Builder addOverrideDeployPolicy(String value)

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The overrideDeployPolicy to add.

Returns
Type Description
TerminateJobRunRequest.Builder

This builder for chaining.

addOverrideDeployPolicyBytes(ByteString value)

public TerminateJobRunRequest.Builder addOverrideDeployPolicyBytes(ByteString value)

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the overrideDeployPolicy to add.

Returns
Type Description
TerminateJobRunRequest.Builder

This builder for chaining.

build()

public TerminateJobRunRequest build()
Returns
Type Description
TerminateJobRunRequest

buildPartial()

public TerminateJobRunRequest buildPartial()
Returns
Type Description
TerminateJobRunRequest

clear()

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

clearName()

public TerminateJobRunRequest.Builder clearName()

Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.

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

Returns
Type Description
TerminateJobRunRequest.Builder

This builder for chaining.

clearOverrideDeployPolicy()

public TerminateJobRunRequest.Builder clearOverrideDeployPolicy()

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
TerminateJobRunRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public TerminateJobRunRequest getDefaultInstanceForType()
Returns
Type Description
TerminateJobRunRequest

getDescriptorForType()

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

getName()

public String getName()

Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.

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

Returns
Type Description
ByteString

The bytes for name.

getOverrideDeployPolicy(int index)

public String getOverrideDeployPolicy(int index)

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The overrideDeployPolicy at the given index.

getOverrideDeployPolicyBytes(int index)

public ByteString getOverrideDeployPolicyBytes(int index)

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the overrideDeployPolicy at the given index.

getOverrideDeployPolicyCount()

public int getOverrideDeployPolicyCount()

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of overrideDeployPolicy.

getOverrideDeployPolicyList()

public ProtocolStringList getOverrideDeployPolicyList()

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the overrideDeployPolicy.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TerminateJobRunRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setName(String value)

public TerminateJobRunRequest.Builder setName(String value)

Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
TerminateJobRunRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public TerminateJobRunRequest.Builder setNameBytes(ByteString value)

Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
TerminateJobRunRequest.Builder

This builder for chaining.

setOverrideDeployPolicy(int index, String value)

public TerminateJobRunRequest.Builder setOverrideDeployPolicy(int index, String value)

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The overrideDeployPolicy to set.

Returns
Type Description
TerminateJobRunRequest.Builder

This builder for chaining.