Interface WorkerPoolRevisionTemplateOrBuilder (0.72.0)

public interface WorkerPoolRevisionTemplateOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

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

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

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

map<string, string> annotations = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public abstract boolean containsLabels(String key)

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

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

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations() (deprecated)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

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

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

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

map<string, string> annotations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

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

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

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

map<string, string> annotations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

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

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

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

map<string, string> annotations = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

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

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

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

map<string, string> annotations = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getContainers(int index)

public abstract Container getContainers(int index)

Holds list of the containers that defines the unit of execution for this Revision.

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

Parameter
Name Description
index int
Returns
Type Description
Container

getContainersCount()

public abstract int getContainersCount()

Holds list of the containers that defines the unit of execution for this Revision.

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

Returns
Type Description
int

getContainersList()

public abstract List<Container> getContainersList()

Holds list of the containers that defines the unit of execution for this Revision.

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

Returns
Type Description
List<Container>

getContainersOrBuilder(int index)

public abstract ContainerOrBuilder getContainersOrBuilder(int index)

Holds list of the containers that defines the unit of execution for this Revision.

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

Parameter
Name Description
index int
Returns
Type Description
ContainerOrBuilder

getContainersOrBuilderList()

public abstract List<? extends ContainerOrBuilder> getContainersOrBuilderList()

Holds list of the containers that defines the unit of execution for this Revision.

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

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

getEncryptionKey()

public abstract 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 = 8 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The encryptionKey.

getEncryptionKeyBytes()

public abstract 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 = 8 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for encryptionKey.

getEncryptionKeyRevocationAction()

public abstract EncryptionKeyRevocationAction getEncryptionKeyRevocationAction()

Optional. The action to take if the encryption key is revoked.

.google.cloud.run.v2.EncryptionKeyRevocationAction encryption_key_revocation_action = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionKeyRevocationAction

The encryptionKeyRevocationAction.

getEncryptionKeyRevocationActionValue()

public abstract int getEncryptionKeyRevocationActionValue()

Optional. The action to take if the encryption key is revoked.

.google.cloud.run.v2.EncryptionKeyRevocationAction encryption_key_revocation_action = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for encryptionKeyRevocationAction.

getEncryptionKeyShutdownDuration()

public abstract Duration getEncryptionKeyShutdownDuration()

Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.

.google.protobuf.Duration encryption_key_shutdown_duration = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The encryptionKeyShutdownDuration.

getEncryptionKeyShutdownDurationOrBuilder()

public abstract DurationOrBuilder getEncryptionKeyShutdownDurationOrBuilder()

Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.

.google.protobuf.Duration encryption_key_shutdown_duration = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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

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

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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

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

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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

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

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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

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

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getNodeSelector()

public abstract NodeSelector getNodeSelector()

Optional. The node selector for the revision template.

.google.cloud.run.v2.NodeSelector node_selector = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NodeSelector

The nodeSelector.

getNodeSelectorOrBuilder()

public abstract NodeSelectorOrBuilder getNodeSelectorOrBuilder()

Optional. The node selector for the revision template.

.google.cloud.run.v2.NodeSelector node_selector = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NodeSelectorOrBuilder

getRevision()

public abstract String getRevision()

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

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

Returns
Type Description
String

The revision.

getRevisionBytes()

public abstract ByteString getRevisionBytes()

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

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

Returns
Type Description
ByteString

The bytes for revision.

getServiceAccount()

public abstract String getServiceAccount()

Optional. 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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public abstract ByteString getServiceAccountBytes()

Optional. 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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for serviceAccount.

getServiceMesh()

public abstract ServiceMesh getServiceMesh()

Optional. Enables service mesh connectivity.

.google.cloud.run.v2.ServiceMesh service_mesh = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ServiceMesh

The serviceMesh.

getServiceMeshOrBuilder()

public abstract ServiceMeshOrBuilder getServiceMeshOrBuilder()

Optional. Enables service mesh connectivity.

.google.cloud.run.v2.ServiceMesh service_mesh = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ServiceMeshOrBuilder

getVolumes(int index)

public abstract Volume getVolumes(int index)

Optional. A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Volume

getVolumesCount()

public abstract int getVolumesCount()

Optional. A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getVolumesList()

public abstract List<Volume> getVolumesList()

Optional. A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Volume>

getVolumesOrBuilder(int index)

public abstract VolumeOrBuilder getVolumesOrBuilder(int index)

Optional. A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
VolumeOrBuilder

getVolumesOrBuilderList()

public abstract List<? extends VolumeOrBuilder> getVolumesOrBuilderList()

Optional. A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 7 [(.google.api.field_behavior) = OPTIONAL];

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

getVpcAccess()

public abstract VpcAccess getVpcAccess()

Optional. 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 = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VpcAccess

The vpcAccess.

getVpcAccessOrBuilder()

public abstract VpcAccessOrBuilder getVpcAccessOrBuilder()

Optional. 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 = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VpcAccessOrBuilder

hasEncryptionKeyShutdownDuration()

public abstract boolean hasEncryptionKeyShutdownDuration()

Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.

.google.protobuf.Duration encryption_key_shutdown_duration = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the encryptionKeyShutdownDuration field is set.

hasNodeSelector()

public abstract boolean hasNodeSelector()

Optional. The node selector for the revision template.

.google.cloud.run.v2.NodeSelector node_selector = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the nodeSelector field is set.

hasServiceMesh()

public abstract boolean hasServiceMesh()

Optional. Enables service mesh connectivity.

.google.cloud.run.v2.ServiceMesh service_mesh = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the serviceMesh field is set.

hasVpcAccess()

public abstract boolean hasVpcAccess()

Optional. 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 = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the vpcAccess field is set.