Class RevisionTemplate (0.43.0)

public final class RevisionTemplate extends GeneratedMessageV3 implements RevisionTemplateOrBuilder

RevisionTemplate describes the data a revision should have when created from a template.

Protobuf type google.cloud.run.v2.RevisionTemplate

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

CONTAINERS_FIELD_NUMBER

public static final int CONTAINERS_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTION_KEY_FIELD_NUMBER

public static final int ENCRYPTION_KEY_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_ENVIRONMENT_FIELD_NUMBER

public static final int EXECUTION_ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

HEALTH_CHECK_DISABLED_FIELD_NUMBER

public static final int HEALTH_CHECK_DISABLED_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MAX_INSTANCE_REQUEST_CONCURRENCY_FIELD_NUMBER

public static final int MAX_INSTANCE_REQUEST_CONCURRENCY_FIELD_NUMBER
Field Value
Type Description
int

REVISION_FIELD_NUMBER

public static final int REVISION_FIELD_NUMBER
Field Value
Type Description
int

SCALING_FIELD_NUMBER

public static final int SCALING_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

SESSION_AFFINITY_FIELD_NUMBER

public static final int SESSION_AFFINITY_FIELD_NUMBER
Field Value
Type Description
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
Type Description
int

VOLUMES_FIELD_NUMBER

public static final int VOLUMES_FIELD_NUMBER
Field Value
Type Description
int

VPC_ACCESS_FIELD_NUMBER

public static final int VPC_ACCESS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RevisionTemplate getDefaultInstance()
Returns
Type Description
RevisionTemplate

getDescriptor()

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

newBuilder()

public static RevisionTemplate.Builder newBuilder()
Returns
Type Description
RevisionTemplate.Builder

newBuilder(RevisionTemplate prototype)

public static RevisionTemplate.Builder newBuilder(RevisionTemplate prototype)
Parameter
Name Description
prototype RevisionTemplate
Returns
Type Description
RevisionTemplate.Builder

parseDelimitedFrom(InputStream input)

public static RevisionTemplate parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RevisionTemplate
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RevisionTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RevisionTemplate
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RevisionTemplate parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RevisionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RevisionTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RevisionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RevisionTemplate parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RevisionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RevisionTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RevisionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RevisionTemplate parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RevisionTemplate
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RevisionTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RevisionTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RevisionTemplate parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RevisionTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RevisionTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RevisionTemplate
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RevisionTemplate parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RevisionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RevisionTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RevisionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RevisionTemplate> parser()
Returns
Type Description
Parser<RevisionTemplate>

Methods

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

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

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

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

map<string, string> labels = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

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

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 3;

Returns
Type Description
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

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

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 3;

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

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

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 3;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

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

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 3;

Parameter
Name Description
key String
Returns
Type Description
String

getContainers(int index)

public Container getContainers(int index)

Holds the single container that defines the unit of execution for this Revision.

repeated .google.cloud.run.v2.Container containers = 10;

Parameter
Name Description
index int
Returns
Type Description
Container

getContainersCount()

public int getContainersCount()

Holds the single container that defines the unit of execution for this Revision.

repeated .google.cloud.run.v2.Container containers = 10;

Returns
Type Description
int

getContainersList()

public List<Container> getContainersList()

Holds the single container that defines the unit of execution for this Revision.

repeated .google.cloud.run.v2.Container containers = 10;

Returns
Type Description
List<Container>

getContainersOrBuilder(int index)

public ContainerOrBuilder getContainersOrBuilder(int index)

Holds the single container that defines the unit of execution for this Revision.

repeated .google.cloud.run.v2.Container containers = 10;

Parameter
Name Description
index int
Returns
Type Description
ContainerOrBuilder

getContainersOrBuilderList()

public List<? extends ContainerOrBuilder> getContainersOrBuilderList()

Holds the single container that defines the unit of execution for this Revision.

repeated .google.cloud.run.v2.Container containers = 10;

Returns
Type Description
List<? extends com.google.cloud.run.v2.ContainerOrBuilder>

getDefaultInstanceForType()

public RevisionTemplate getDefaultInstanceForType()
Returns
Type Description
RevisionTemplate

getEncryptionKey()

public String getEncryptionKey()

A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek

string encryption_key = 14 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The encryptionKey.

getEncryptionKeyBytes()

public ByteString getEncryptionKeyBytes()

A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek

string encryption_key = 14 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for encryptionKey.

getExecutionEnvironment()

public ExecutionEnvironment getExecutionEnvironment()

The sandbox environment to host this Revision.

.google.cloud.run.v2.ExecutionEnvironment execution_environment = 13;

Returns
Type Description
ExecutionEnvironment

The executionEnvironment.

getExecutionEnvironmentValue()

public int getExecutionEnvironmentValue()

The sandbox environment to host this Revision.

.google.cloud.run.v2.ExecutionEnvironment execution_environment = 13;

Returns
Type Description
int

The enum numeric value on the wire for executionEnvironment.

getHealthCheckDisabled()

public boolean getHealthCheckDisabled()

Optional. Disables health checking containers during deployment.

bool health_check_disabled = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The healthCheckDisabled.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

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

map<string, string> labels = 2;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

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

map<string, string> labels = 2;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

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

map<string, string> labels = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

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

map<string, string> labels = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getMaxInstanceRequestConcurrency()

public int getMaxInstanceRequestConcurrency()

Sets the maximum number of requests that each serving instance can receive.

int32 max_instance_request_concurrency = 15;

Returns
Type Description
int

The maxInstanceRequestConcurrency.

getParserForType()

public Parser<RevisionTemplate> getParserForType()
Returns
Type Description
Parser<RevisionTemplate>
Overrides

getRevision()

public String getRevision()

The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.

string revision = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The revision.

getRevisionBytes()

public ByteString getRevisionBytes()

The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.

string revision = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for revision.

getScaling()

public RevisionScaling getScaling()

Scaling settings for this Revision.

.google.cloud.run.v2.RevisionScaling scaling = 4;

Returns
Type Description
RevisionScaling

The scaling.

getScalingOrBuilder()

public RevisionScalingOrBuilder getScalingOrBuilder()

Scaling settings for this Revision.

.google.cloud.run.v2.RevisionScaling scaling = 4;

Returns
Type Description
RevisionScalingOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public String getServiceAccount()

Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.

string service_account = 9;

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.

string service_account = 9;

Returns
Type Description
ByteString

The bytes for serviceAccount.

getSessionAffinity()

public boolean getSessionAffinity()

Optional. Enable session affinity.

bool session_affinity = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The sessionAffinity.

getTimeout()

public Duration getTimeout()

Max allowed time for an instance to respond to a request.

.google.protobuf.Duration timeout = 8;

Returns
Type Description
Duration

The timeout.

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

Max allowed time for an instance to respond to a request.

.google.protobuf.Duration timeout = 8;

Returns
Type Description
DurationOrBuilder

getVolumes(int index)

public Volume getVolumes(int index)

A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 11;

Parameter
Name Description
index int
Returns
Type Description
Volume

getVolumesCount()

public int getVolumesCount()

A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 11;

Returns
Type Description
int

getVolumesList()

public List<Volume> getVolumesList()

A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 11;

Returns
Type Description
List<Volume>

getVolumesOrBuilder(int index)

public VolumeOrBuilder getVolumesOrBuilder(int index)

A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 11;

Parameter
Name Description
index int
Returns
Type Description
VolumeOrBuilder

getVolumesOrBuilderList()

public List<? extends VolumeOrBuilder> getVolumesOrBuilderList()

A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 11;

Returns
Type Description
List<? extends com.google.cloud.run.v2.VolumeOrBuilder>

getVpcAccess()

public VpcAccess getVpcAccess()

VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

.google.cloud.run.v2.VpcAccess vpc_access = 6;

Returns
Type Description
VpcAccess

The vpcAccess.

getVpcAccessOrBuilder()

public VpcAccessOrBuilder getVpcAccessOrBuilder()

VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

.google.cloud.run.v2.VpcAccess vpc_access = 6;

Returns
Type Description
VpcAccessOrBuilder

hasScaling()

public boolean hasScaling()

Scaling settings for this Revision.

.google.cloud.run.v2.RevisionScaling scaling = 4;

Returns
Type Description
boolean

Whether the scaling field is set.

hasTimeout()

public boolean hasTimeout()

Max allowed time for an instance to respond to a request.

.google.protobuf.Duration timeout = 8;

Returns
Type Description
boolean

Whether the timeout field is set.

hasVpcAccess()

public boolean hasVpcAccess()

VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

.google.cloud.run.v2.VpcAccess vpc_access = 6;

Returns
Type Description
boolean

Whether the vpcAccess field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RevisionTemplate.Builder newBuilderForType()
Returns
Type Description
RevisionTemplate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RevisionTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RevisionTemplate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RevisionTemplate.Builder toBuilder()
Returns
Type Description
RevisionTemplate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException