Console
    Contact Us Start free

    Google Cloud Run V2 Client - Class WorkerPoolRevisionTemplate (1.9.0)

    Reference documentation and code samples for the Google Cloud Run V2 Client class WorkerPoolRevisionTemplate.

    WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template.

    Generated from protobuf message google.cloud.run.v2.WorkerPoolRevisionTemplate

    Namespace

    Google \ Cloud \ Run \ V2

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ revision
    string

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

    ↳ labels
    array| Google\Protobuf\Internal\MapField

    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.

    ↳ annotations
    array| Google\Protobuf\Internal\MapField

    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.

    ↳ vpc_access
    VpcAccess

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

    ↳ service_account
    string

    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.

    ↳ containers
    array< Container >

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

    ↳ volumes
    array< Volume >

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

    ↳ encryption_key
    string

    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

    ↳ service_mesh
    ServiceMesh

    Optional. Enables service mesh connectivity.

    ↳ encryption_key_revocation_action
    int

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

    ↳ encryption_key_shutdown_duration
    Google\Protobuf\Duration

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

    ↳ node_selector
    NodeSelector

    Optional. The node selector for the revision template.

    getRevision

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

    Returns
    Type
    Description
    string

    setRevision

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getLabels

    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.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    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.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getAnnotations

    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.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setAnnotations

    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.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getVpcAccess

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

    Returns
    Type
    Description
    VpcAccess |null

    hasVpcAccess

    clearVpcAccess

    setVpcAccess

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

    Parameter
    Name
    Description
    var
    VpcAccess
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    setServiceAccount

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getContainers

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

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setContainers

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

    Parameter
    Name
    Description
    var
    array< Container >
    Returns
    Type
    Description
    $this

    getVolumes

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

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setVolumes

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

    Parameter
    Name
    Description
    var
    array< Volume >
    Returns
    Type
    Description
    $this

    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

    Returns
    Type
    Description
    string

    setEncryptionKey

    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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getServiceMesh

    Optional. Enables service mesh connectivity.

    Returns
    Type
    Description
    ServiceMesh |null

    hasServiceMesh

    clearServiceMesh

    setServiceMesh

    Optional. Enables service mesh connectivity.

    Parameter
    Name
    Description
    var
    ServiceMesh
    Returns
    Type
    Description
    $this

    getEncryptionKeyRevocationAction

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

    Returns
    Type
    Description
    int

    setEncryptionKeyRevocationAction

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

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getEncryptionKeyShutdownDuration

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

    Returns
    Type
    Description
    Google\Protobuf\Duration |null

    hasEncryptionKeyShutdownDuration

    clearEncryptionKeyShutdownDuration

    setEncryptionKeyShutdownDuration

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

    Parameter
    Name
    Description
    var
    Google\Protobuf\Duration
    Returns
    Type
    Description
    $this

    getNodeSelector

    Optional. The node selector for the revision template.

    Returns
    Type
    Description
    NodeSelector |null

    hasNodeSelector

    clearNodeSelector

    setNodeSelector

    Optional. The node selector for the revision template.

    Parameter
    Name
    Description
    var
    NodeSelector
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: