Class ExecutionTemplate (0.14.0)

public final class ExecutionTemplate extends GeneratedMessageV3 implements ExecutionTemplateOrBuilder

ExecutionTemplate describes the data an execution should have when created from a template.

Protobuf type google.cloud.run.v2.ExecutionTemplate

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

PARALLELISM_FIELD_NUMBER

public static final int PARALLELISM_FIELD_NUMBER
Field Value
TypeDescription
int

TASK_COUNT_FIELD_NUMBER

public static final int TASK_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

TEMPLATE_FIELD_NUMBER

public static final int TEMPLATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExecutionTemplate getDefaultInstance()
Returns
TypeDescription
ExecutionTemplate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ExecutionTemplate.Builder newBuilder()
Returns
TypeDescription
ExecutionTemplate.Builder

newBuilder(ExecutionTemplate prototype)

public static ExecutionTemplate.Builder newBuilder(ExecutionTemplate prototype)
Parameter
NameDescription
prototypeExecutionTemplate
Returns
TypeDescription
ExecutionTemplate.Builder

parseDelimitedFrom(InputStream input)

public static ExecutionTemplate parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExecutionTemplate
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionTemplate
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExecutionTemplate parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExecutionTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecutionTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecutionTemplate parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExecutionTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecutionTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecutionTemplate parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExecutionTemplate
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionTemplate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExecutionTemplate parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExecutionTemplate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionTemplate
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExecutionTemplate parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExecutionTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecutionTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExecutionTemplate> parser()
Returns
TypeDescription
Parser<ExecutionTemplate>

Methods

containsAnnotations(String key)

public boolean containsAnnotations(String key)

KRM-style annotations for the resource. <p>Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> annotations = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsLabels(String key)

public boolean containsLabels(String key)

KRM-style labels for the resource. <p>Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> labels = 1;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

KRM-style annotations for the resource. <p>Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> annotations = 2;

Returns
TypeDescription
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

KRM-style annotations for the resource. <p>Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> annotations = 2;

Returns
TypeDescription
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

KRM-style annotations for the resource. <p>Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> annotations = 2;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

KRM-style annotations for the resource. <p>Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> annotations = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getDefaultInstanceForType()

public ExecutionTemplate getDefaultInstanceForType()
Returns
TypeDescription
ExecutionTemplate

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

KRM-style labels for the resource. <p>Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> labels = 1;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

KRM-style labels for the resource. <p>Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> labels = 1;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

KRM-style labels for the resource. <p>Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> labels = 1;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

KRM-style labels for the resource. <p>Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> labels = 1;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getParallelism()

public int getParallelism()

Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism.

int32 parallelism = 3;

Returns
TypeDescription
int

The parallelism.

getParserForType()

public Parser<ExecutionTemplate> getParserForType()
Returns
TypeDescription
Parser<ExecutionTemplate>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTaskCount()

public int getTaskCount()

Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

int32 task_count = 4;

Returns
TypeDescription
int

The taskCount.

getTemplate()

public TaskTemplate getTemplate()

Required. Describes the task(s) that will be created when executing an execution.

.google.cloud.run.v2.TaskTemplate template = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
TaskTemplate

The template.

getTemplateOrBuilder()

public TaskTemplateOrBuilder getTemplateOrBuilder()

Required. Describes the task(s) that will be created when executing an execution.

.google.cloud.run.v2.TaskTemplate template = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
TaskTemplateOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasTemplate()

public boolean hasTemplate()

Required. Describes the task(s) that will be created when executing an execution.

.google.cloud.run.v2.TaskTemplate template = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the template field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExecutionTemplate.Builder newBuilderForType()
Returns
TypeDescription
ExecutionTemplate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExecutionTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExecutionTemplate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExecutionTemplate.Builder toBuilder()
Returns
TypeDescription
ExecutionTemplate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException