Information for connecting over HTTP(s).
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { “audit_configs”: [ { “service”: “allServices”, “audit_log_configs”: [ { “log_type”: “DATA_READ”, “exempted_members”: [ “user:jose@example.com” ] }, { “log_type”: “DATA_WRITE” }, { “log_type”: “ADMIN_READ” } ] }, { “service”: “sampleservice.googleapis.com”, “audit_log_configs”: [ { “log_type”: “DATA_READ” }, { “log_type”: “DATA_WRITE”, “exempted_members”: [ “user:aliya@example.com” ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Provides the configuration for logging a type of permissions. Example: { “audit_log_configs”: [ { “log_type”: “DATA_READ”, “exempted_members”: [ “user:jose@example.com” ] }, { “log_type”: “DATA_WRITE” } ] } This enables ‘DATA_READ’ and ‘DATA_WRITE’ logging, while exempting jose@example.com from DATA_READ logging.
A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via
Search Console.
Associates members, or principals, with a role.
Storage volume source using the Container Storage Interface.
Request message for cancelling an execution.
Central instance to access all CloudRun related resource activities
Not supported by Cloud Run. ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap’s Data field will represent the key-value pairs as environment variables.
Not supported by Cloud Run.
Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths.
Configuration represents the “floating HEAD” of a linear history of Revisions, and optionally how the containers those revisions reference are built. Users create new Revisions by updating the Configuration’s spec. The “latest created” revision’s name is available under status, as is the “latest ready” revision’s name.
ConfigurationSpec holds the desired state of the Configuration (from the client).
ConfigurationStatus communicates the observed state of the Configuration (from the controller).
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 may be supplied by the system to the container at runtime.
Per container override specification.
ContainerPort represents a network port in a single container.
Resource to hold the state and status of a user’s domain mapping. NOTE: This resource is currently in Beta.
The desired state of the Domain Mapping.
The current state of the Domain Mapping.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
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).
Not supported by Cloud Run. EnvFromSource represents the source of a set of ConfigMaps
EnvVar represents an environment variable present in a Container.
EnvVarSource represents a source for the value of an EnvVar.
Not supported by Cloud Run. ExecAction describes a “run in container” action.
Execution represents the configuration of a single execution. An execution is an immutable resource that references a container image which is run to completion.
Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status.
ExecutionSpec describes how the execution will look.
ExecutionStatus represents the current state of an Execution.
ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job.
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: “Summary size limit” description: “Determines if a summary is less than 100 chars” expression: “document.summary.size() < 100” Example (Equality): title: “Requestor is owner” description: “Determines if requestor is the document owner” expression: “document.owner == request.auth.claims.email” Example (Logic): title: “Public documents” description: “Determine whether the document should be publicly visible” expression: “document.type != ‘private’ && document.type != ‘internal’” Example (Data Manipulation): title: “Notification string” description: “Create a notification string with a timestamp.” expression: “’New message received at ’ + string(document.create_time)” The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
GRPCAction describes an action involving a GRPC port.
Conditions show the status of reconciliation progress on a given resource. Most resource use a top-level condition type “Ready” or “Completed” to show overall status with other conditions to checkpoint each stage of reconciliation. Note that if metadata.Generation does not equal status.ObservedGeneration, the conditions shown may not be relevant for the current spec.
The response message for Operations.ListOperations.
This resource represents a long-running operation that is the result of a network API call.
The request message for Operations.WaitOperation.
The
Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by
gRPC. Each
Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the
API Design Guide.
HTTPGetAction describes an action based on HTTP Get requests.
HTTPHeader describes a custom header to be used in HTTP probes
Job represents the configuration of a single job, which references a container image which is run to completion.
JobSpec describes how the job will look.
JobStatus represents the current state of a Job.
Maps a string key to a path within a volume.
A list of Authorized Domains.
ListConfigurationsResponse is a list of Configuration resources.
ListDomainMappingsResponse is a list of DomainMapping resources.
ListExecutionsResponse is a list of Executions resources.
ListJobsResponse is a list of Jobs resources.
The response message for Locations.ListLocations.
Metadata for synthetic resources like List. In Cloud Run, all List Resources Responses will have a ListMeta instead of ObjectMeta.
ListRevisionsResponse is a list of Revision resources.
ListRoutesResponse is a list of Route resources.
A list of Service resources.
ListTasksResponse is a list of Tasks resources.
Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
A resource that represents a Google Cloud location.
Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the Service and data will not be deleted when the instance is shut down.
List authorized domains.
Get information about a configuration.
List configurations.
Create a new domain mapping.
Delete a domain mapping.
Get information about a domain mapping.
List all domain mappings.
Cancel an execution.
Delete an execution.
Get information about an execution.
List executions.
Create a job.
Delete a job.
Get information about a job.
List jobs.
Replace a job. Only the spec and metadata labels and annotations are modifiable. After the Replace request, Cloud Run will work to make the ‘status’ match the requested ‘spec’. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.
Trigger creation of a new execution of this job.
A builder providing access to all methods supported on
namespace resources.
It is not used directly, but through the
CloudRun hub.
Delete a revision.
Get information about a revision.
List revisions.
Get information about a route.
List routes.
Creates a new Service. Service creation will trigger a new deployment. Use GetService, and check service.status to determine if the Service is ready.
Deletes the provided service. This will cause the Service to stop serving traffic and will delete all associated Revisions.
Gets information about a service.
Lists services for the given project and region.
Replaces a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the ‘status’ match the requested ‘spec’. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.
Get information about a task.
List tasks.
google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
RunJob Overrides that contains Execution fields to be overridden on the go.
This is not supported or used by Cloud Run.
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A
Policy is a collection of
bindings. A
binding binds one or more
members, or principals, to a single
role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A
role is a named list of permissions; each
role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a
binding can also specify a
condition, which is a logical expression that allows access to a resource only if the expression evaluates to
true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the
IAM documentation.
JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the
IAM documentation.
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
List authorized domains.
List authorized domains.
Get information about a configuration.
List configurations.
Create a new domain mapping.
Delete a domain mapping.
Get information about a domain mapping.
List all domain mappings.
Get the IAM Access Control policy currently in effect for the given job. This result does not include any inherited policies.
Sets the IAM Access control policy for the specified job. Overwrites any existing policy.
Returns permissions that a caller has on the specified job. There are no permissions required for making this API call.
Lists information about the supported locations for this service.
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Delete a revision.
Get information about a revision.
List revisions.
Get information about a route.
List routes.
Creates a new Service. Service creation will trigger a new deployment. Use GetService, and check service.status to determine if the Service is ready.
Deletes the provided service. This will cause the Service to stop serving traffic and will delete all associated Revisions.
Gets information about a service.
Gets the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies.
Lists services for the given project and region.
Replaces a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the ‘status’ match the requested ‘spec’. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.
Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.
Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.
A builder providing access to all methods supported on
project resources.
It is not used directly, but through the
CloudRun hub.
A DNS resource record.
ResourceRequirements describes the compute resource requirements.
Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration. See also: https://github.com/knative/specs/blob/main/specs/serving/overview.md#revision
RevisionSpec holds the desired state of the Revision (from the client).
RevisionStatus communicates the observed state of the Revision (from the controller).
RevisionTemplateSpec describes the data a revision should have when created from a template.
Route is responsible for configuring ingress over a collection of Revisions. Some of the Revisions a Route distributes traffic over may be specified by referencing the Configuration responsible for creating them; in these cases the Route is additionally responsible for monitoring the Configuration for “latest ready” revision changes, and smoothly rolling out latest revisions. Cloud Run currently supports referencing a single Configuration to automatically deploy the “latest ready” Revision from that Configuration.
RouteSpec holds the desired state of the Route (from the client).
RouteStatus communicates the observed state of the Route (from the controller).
Request message for creating a new execution of a job.
Not supported by Cloud Run. SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret’s Data field will represent the key-value pairs as environment variables.
SecretKeySelector selects a key of a Secret.
A volume representing a secret stored in Google Secret Manager. 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_name. The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names.
Not supported by Cloud Run. SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
Service acts as a top-level container that manages a set of Routes and Configurations 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. Service acts only as an orchestrator of the underlying Routes and Configurations (much as a kubernetes Deployment orchestrates ReplicaSets). The Service’s controller will track the statuses of its owned Configuration and Route, reflecting their statuses and conditions as its own.
ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s).
The current state of the Service. Output only.
Request message for SetIamPolicy method.
Status is a return value for calls that don’t return other objects.
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
TCPSocketAction describes an action based on opening a socket
Task represents a single run of a container to completion.
Result of a task attempt.
TaskSpec is a description of a task.
TaskStatus represents the status of a task.
TaskTemplateSpec describes the data a task should have when created from a template.
Request message for TestIamPermissions method.
Response message for TestIamPermissions method.
TrafficTarget holds a single entry of the routing table for a Route.
Volume represents a named volume in a container.
VolumeMount describes a mounting of a Volume within a container.