com.google.cloud.run.v2

Interface RevisionTemplateOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RevisionTemplate, RevisionTemplate.Builder

public interface RevisionTemplateOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsAnnotations(String key) Unstructured key value map that may be set by external tools to store and arbitrary metadata.
boolean	containsLabels(String key) Unstructured key value map that can be used to organize and categorize objects.
Map<String,String>	getAnnotations() Deprecated.
int	getAnnotationsCount() Unstructured key value map that may be set by external tools to store and arbitrary metadata.
Map<String,String>	getAnnotationsMap() Unstructured key value map that may be set by external tools to store and arbitrary metadata.
String	getAnnotationsOrDefault(String key, String defaultValue) Unstructured key value map that may be set by external tools to store and arbitrary metadata.
String	getAnnotationsOrThrow(String key) Unstructured key value map that may be set by external tools to store and arbitrary metadata.
Container	getContainers(int index) Holds the single container that defines the unit of execution for this Revision.
int	getContainersCount() Holds the single container that defines the unit of execution for this Revision.
List<Container>	getContainersList() Holds the single container that defines the unit of execution for this Revision.
ContainerOrBuilder	getContainersOrBuilder(int index) Holds the single container that defines the unit of execution for this Revision.
List<? extends ContainerOrBuilder>	getContainersOrBuilderList() Holds the single container that defines the unit of execution for this Revision.
String	getEncryptionKey() A reference to a customer managed encryption key (CMEK) to use to encrypt this container image.
com.google.protobuf.ByteString	getEncryptionKeyBytes() A reference to a customer managed encryption key (CMEK) to use to encrypt this container image.
ExecutionEnvironment	getExecutionEnvironment() The sandbox environment to host this Revision.
int	getExecutionEnvironmentValue() The sandbox environment to host this Revision.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Unstructured key value map that can be used to organize and categorize objects.
Map<String,String>	getLabelsMap() Unstructured key value map that can be used to organize and categorize objects.
String	getLabelsOrDefault(String key, String defaultValue) Unstructured key value map that can be used to organize and categorize objects.
String	getLabelsOrThrow(String key) Unstructured key value map that can be used to organize and categorize objects.
int	getMaxInstanceRequestConcurrency() Sets the maximum number of requests that each serving instance can receive.
String	getRevision() The unique name for the revision.
com.google.protobuf.ByteString	getRevisionBytes() The unique name for the revision.
RevisionScaling	getScaling() Scaling settings for this Revision.
RevisionScalingOrBuilder	getScalingOrBuilder() Scaling settings for this Revision.
String	getServiceAccount() Email address of the IAM service account associated with the revision of the service.
com.google.protobuf.ByteString	getServiceAccountBytes() Email address of the IAM service account associated with the revision of the service.
boolean	getSessionAffinity() Enable session affinity.
com.google.protobuf.Duration	getTimeout() Max allowed time for an instance to respond to a request.
com.google.protobuf.DurationOrBuilder	getTimeoutOrBuilder() Max allowed time for an instance to respond to a request.
Volume	getVolumes(int index) A list of Volumes to make available to containers.
int	getVolumesCount() A list of Volumes to make available to containers.
List<Volume>	getVolumesList() A list of Volumes to make available to containers.
VolumeOrBuilder	getVolumesOrBuilder(int index) A list of Volumes to make available to containers.
List<? extends VolumeOrBuilder>	getVolumesOrBuilderList() A list of Volumes to make available to containers.
VpcAccess	getVpcAccess() VPC Access configuration to use for this Revision.
VpcAccessOrBuilder	getVpcAccessOrBuilder() VPC Access configuration to use for this Revision.
boolean	hasScaling() Scaling settings for this Revision.
boolean	hasTimeout() Max allowed time for an instance to respond to a request.
boolean	hasVpcAccess() VPC Access configuration to use for this Revision.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getRevision

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:

The revision.

getRevisionBytes

com.google.protobuf.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:

The bytes for revision.

getLabelsCount

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;

containsLabels

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;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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;

getLabelsOrDefault

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;

getLabelsOrThrow

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;

getAnnotationsCount

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;

containsAnnotations

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;

getAnnotations

@Deprecated
Map<String,String> getAnnotations()

Deprecated.

Use getAnnotationsMap() instead.

getAnnotationsMap

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;

getAnnotationsOrDefault

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;

getAnnotationsOrThrow

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;

hasScaling

boolean hasScaling()

 Scaling settings for this Revision.
 

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

Returns:

Whether the scaling field is set.

getScaling

RevisionScaling getScaling()

 Scaling settings for this Revision.
 

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

Returns:

The scaling.

getScalingOrBuilder

RevisionScalingOrBuilder getScalingOrBuilder()

 Scaling settings for this Revision.
 

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

hasVpcAccess

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:

Whether the vpcAccess field is set.

getVpcAccess

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:

The vpcAccess.

getVpcAccessOrBuilder

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;

hasTimeout

boolean hasTimeout()

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

.google.protobuf.Duration timeout = 8;

Returns:

Whether the timeout field is set.

getTimeout

com.google.protobuf.Duration getTimeout()

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

.google.protobuf.Duration timeout = 8;

Returns:

The timeout.

getTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()

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

.google.protobuf.Duration timeout = 8;

getServiceAccount

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:

The serviceAccount.

getServiceAccountBytes

com.google.protobuf.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:

The bytes for serviceAccount.

getContainersList

List<Container> getContainersList()

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

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

getContainers

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;

getContainersCount

int getContainersCount()

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

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

getContainersOrBuilderList

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;

getContainersOrBuilder

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;

getVolumesList

List<Volume> getVolumesList()

 A list of Volumes to make available to containers.
 

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

getVolumes

Volume getVolumes(int index)

 A list of Volumes to make available to containers.
 

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

getVolumesCount

int getVolumesCount()

 A list of Volumes to make available to containers.
 

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

getVolumesOrBuilderList

List<? extends VolumeOrBuilder> getVolumesOrBuilderList()

 A list of Volumes to make available to containers.
 

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

getVolumesOrBuilder

VolumeOrBuilder getVolumesOrBuilder(int index)

 A list of Volumes to make available to containers.
 

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

getExecutionEnvironmentValue

int getExecutionEnvironmentValue()

 The sandbox environment to host this Revision.
 

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

Returns:

The enum numeric value on the wire for executionEnvironment.

getExecutionEnvironment

ExecutionEnvironment getExecutionEnvironment()

 The sandbox environment to host this Revision.
 

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

Returns:

The executionEnvironment.

getEncryptionKey

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:

The encryptionKey.

getEncryptionKeyBytes

com.google.protobuf.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:

The bytes for encryptionKey.

getMaxInstanceRequestConcurrency

int getMaxInstanceRequestConcurrency()

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

int32 max_instance_request_concurrency = 15;

Returns:

The maxInstanceRequestConcurrency.

getSessionAffinity

boolean getSessionAffinity()

 Enable session affinity.
 

bool session_affinity = 19;

Returns:

The sessionAffinity.