Package Classes (0.10.9)

Summary of entries of Classes for run.

Classes

BuildsAsyncClient

Cloud Run Build Control Plane API

BuildsClient

Cloud Run Build Control Plane API

ExecutionsAsyncClient

Cloud Run Execution Control Plane API.

ExecutionsClient

Cloud Run Execution Control Plane API.

ListExecutionsAsyncPager

A pager for iterating through list_executions requests.

This class thinly wraps an initial ListExecutionsResponse object, and provides an __aiter__ method to iterate through its executions field.

If there are more pages, the __aiter__ method will make additional ListExecutions requests and continue to iterate through the executions field on the corresponding responses.

All the usual ListExecutionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListExecutionsPager

A pager for iterating through list_executions requests.

This class thinly wraps an initial ListExecutionsResponse object, and provides an __iter__ method to iterate through its executions field.

If there are more pages, the __iter__ method will make additional ListExecutions requests and continue to iterate through the executions field on the corresponding responses.

All the usual ListExecutionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

JobsAsyncClient

Cloud Run Job Control Plane API.

JobsClient

Cloud Run Job Control Plane API.

ListJobsAsyncPager

A pager for iterating through list_jobs requests.

This class thinly wraps an initial ListJobsResponse object, and provides an __aiter__ method to iterate through its jobs field.

If there are more pages, the __aiter__ method will make additional ListJobs requests and continue to iterate through the jobs field on the corresponding responses.

All the usual ListJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListJobsPager

A pager for iterating through list_jobs requests.

This class thinly wraps an initial ListJobsResponse object, and provides an __iter__ method to iterate through its jobs field.

If there are more pages, the __iter__ method will make additional ListJobs requests and continue to iterate through the jobs field on the corresponding responses.

All the usual ListJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

RevisionsAsyncClient

Cloud Run Revision Control Plane API.

RevisionsClient

Cloud Run Revision Control Plane API.

ListRevisionsAsyncPager

A pager for iterating through list_revisions requests.

This class thinly wraps an initial ListRevisionsResponse object, and provides an __aiter__ method to iterate through its revisions field.

If there are more pages, the __aiter__ method will make additional ListRevisions requests and continue to iterate through the revisions field on the corresponding responses.

All the usual ListRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRevisionsPager

A pager for iterating through list_revisions requests.

This class thinly wraps an initial ListRevisionsResponse object, and provides an __iter__ method to iterate through its revisions field.

If there are more pages, the __iter__ method will make additional ListRevisions requests and continue to iterate through the revisions field on the corresponding responses.

All the usual ListRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ServicesAsyncClient

Cloud Run Service Control Plane API

ServicesClient

Cloud Run Service Control Plane API

ListServicesAsyncPager

A pager for iterating through list_services requests.

This class thinly wraps an initial ListServicesResponse object, and provides an __aiter__ method to iterate through its services field.

If there are more pages, the __aiter__ method will make additional ListServices requests and continue to iterate through the services field on the corresponding responses.

All the usual ListServicesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListServicesPager

A pager for iterating through list_services requests.

This class thinly wraps an initial ListServicesResponse object, and provides an __iter__ method to iterate through its services field.

If there are more pages, the __iter__ method will make additional ListServices requests and continue to iterate through the services field on the corresponding responses.

All the usual ListServicesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

TasksAsyncClient

Cloud Run Task Control Plane API.

TasksClient

Cloud Run Task Control Plane API.

ListTasksAsyncPager

A pager for iterating through list_tasks requests.

This class thinly wraps an initial ListTasksResponse object, and provides an __aiter__ method to iterate through its tasks field.

If there are more pages, the __aiter__ method will make additional ListTasks requests and continue to iterate through the tasks field on the corresponding responses.

All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTasksPager

A pager for iterating through list_tasks requests.

This class thinly wraps an initial ListTasksResponse object, and provides an __iter__ method to iterate through its tasks field.

If there are more pages, the __iter__ method will make additional ListTasks requests and continue to iterate through the tasks field on the corresponding responses.

All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

BinaryAuthorization

Settings for Binary Authorization feature.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CancelExecutionRequest

Request message for deleting an Execution.

CloudSqlInstance

Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.

Condition

Defines a status condition for a resource.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CommonReason

Reasons common to all types of conditions.

ExecutionReason

Reasons specific to Execution resource.

RevisionReason

Reasons specific to Revision resource.

Severity

Represents the severity of the condition failures.

State

Represents the possible Condition states.

Container

A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments can be supplied by the system to the container at runtime.

ContainerPort

ContainerPort represents a network port in a single container.

CreateJobRequest

Request message for creating a Job.

CreateServiceRequest

Request message for creating a Service.

DeleteExecutionRequest

Request message for deleting an Execution.

DeleteJobRequest

Request message to delete a Job by its full name.

DeleteRevisionRequest

Request message for deleting a retired Revision. Revision lifecycle is usually managed by making changes to the parent Service. Only retired revisions can be deleted with this API.

DeleteServiceRequest

Request message to delete a Service by its full name.

EmptyDirVolumeSource

In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs).

Medium

The different types of medium supported for EmptyDir.

EncryptionKeyRevocationAction

Specifies behavior if an encryption key used by a resource is revoked.

EnvVar

EnvVar represents an environment variable present in a Container.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Execution

Execution represents the configuration of a single execution. A execution an immutable resource that references a container image which is run to completion.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

ExecutionEnvironment

Alternatives for execution environments.

ExecutionReference

Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status.

CompletionStatus

Possible execution completion status.

ExecutionTemplate

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

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

GCSVolumeSource

Represents a volume backed by a Cloud Storage bucket using Cloud Storage FUSE.

GRPCAction

GRPCAction describes an action involving a GRPC port.

GetExecutionRequest

Request message for obtaining a Execution by its full name.

GetJobRequest

Request message for obtaining a Job by its full name.

GetRevisionRequest

Request message for obtaining a Revision by its full name.

GetServiceRequest

Request message for obtaining a Service by its full name.

GetTaskRequest

Request message for obtaining a Task by its full name.

HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

IngressTraffic

Allowed ingress traffic for the Container.

Job

Job represents the configuration of a single job, which references a container image that is run to completion.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

ListExecutionsRequest

Request message for retrieving a list of Executions.

ListExecutionsResponse

Response message containing a list of Executions.

ListJobsRequest

Request message for retrieving a list of Jobs.

ListJobsResponse

Response message containing a list of Jobs.

ListRevisionsRequest

Request message for retrieving a list of Revisions.

ListRevisionsResponse

Response message containing a list of Revisions.

ListServicesRequest

Request message for retrieving a list of Services.

ListServicesResponse

Response message containing a list of Services.

ListTasksRequest

Request message for retrieving a list of Tasks.

ListTasksResponse

Response message containing a list of Tasks.

NFSVolumeSource

Represents an NFS mount.

NodeSelector

Hardware constraints configuration.

Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ResourceRequirements

ResourceRequirements describes the compute resource requirements.

LimitsEntry

The abstract base class for a message.

Revision

A Revision is an immutable snapshot of code and configuration. A Revision references a container image. Revisions are only created by updates to its parent Service.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

RevisionScaling

Settings for revision-level scaling settings.

RevisionScalingStatus

Effective settings for the current revision

RevisionTemplate

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

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

RunJobRequest

Request message to create a new Execution of a Job.

Overrides

RunJob Overrides that contains Execution fields to be overridden.

ContainerOverride

Per-container override specification.

SecretKeySelector

SecretEnvVarSource represents a source for the value of an EnvVar.

SecretVolumeSource

The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret.

Service

Service acts as a top-level container that manages a set of configurations and revision templates which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

ServiceMesh

Settings for Cloud Service Mesh. For more information see https://cloud.google.com/service-mesh/docs/overview.

ServiceScaling

Scaling settings applied at the service level rather than at the revision level.

ScalingMode

The scaling mode for the service. If not provided, it defaults to AUTOMATIC.

StorageSource

Location of the source in an archive file in Google Cloud Storage.

SubmitBuildRequest

Request message for submitting a Build.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BuildpacksBuild

Build the source using Buildpacks.

EnvironmentVariablesEntry

The abstract base class for a message.

DockerBuild

Build the source using Docker. This means the source has a Dockerfile.

SubmitBuildResponse

Response message for submitting a Build.

TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Task

Task represents a single run of a container to completion.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

TaskAttemptResult

Result of a task attempt.

TaskTemplate

TaskTemplate describes the data a task should have when created from a template.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TrafficTarget

Holds a single traffic routing entry for the Service. Allocations can be done to a specific Revision name, or pointing to the latest Ready Revision.

TrafficTargetAllocationType

The type of instance allocation.

TrafficTargetStatus

Represents the observed state of a single TrafficTarget entry.

UpdateJobRequest

Request message for updating a Job.

UpdateServiceRequest

Request message for updating a service.

VersionToPath

VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path.

Volume

Volume represents a named volume in a container.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

VolumeMount

VolumeMount describes a mounting of a Volume within a container.

VpcAccess

VPC Access settings. For more information on sending traffic to a VPC network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

NetworkInterface

Direct VPC egress settings.

VpcEgress

Egress options for VPC access.

Modules

pagers

API documentation for run_v2.services.executions.pagers module.

pagers

API documentation for run_v2.services.jobs.pagers module.

pagers

API documentation for run_v2.services.revisions.pagers module.

pagers

API documentation for run_v2.services.services.pagers module.

pagers

API documentation for run_v2.services.tasks.pagers module.