run.v1 library Null safety
Cloud Run Admin API - v1
Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/.
For more information, see cloud.google.com/run/
Create an instance of CloudRunApi to access these resources:
Classes
- Addressable
- Information for connecting over HTTP(s).
- AuditConfig
- Specifies the audit configuration for a service.
- AuthorizedDomain
- A domain that a user has been authorized to administer.
- Binding
-
Associates
members, or principals, with arole. - CloudRunApi
- Deploy and manage user provided container images that scale automatically based on incoming requests.
- ConfigMapEnvSource
- Not supported by Cloud Run ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
- ConfigMapKeySelector
- Not supported by Cloud Run Selects a key from a ConfigMap.
- ConfigMapVolumeSource
- Not supported by Cloud Run Adapts a ConfigMap into a volume.
- Configuration
- Configuration represents the "floating HEAD" of a linear history of Revisions, and optionally how the containers those revisions reference are built.
- ConfigurationSpec
- ConfigurationSpec holds the desired state of the Configuration (from the client).
- ConfigurationStatus
- ConfigurationStatus communicates the observed state of the Configuration (from the controller).
- Container
- A single application container.
- ContainerPort
- ContainerPort represents a network port in a single container.
- DomainMapping
- Resource to hold the state and status of a user's domain mapping.
- DomainMappingSpec
- The desired state of the Domain Mapping.
- DomainMappingStatus
- The current state of the Domain Mapping.
- EnvFromSource
- Not supported by Cloud Run EnvFromSource represents the source of a set of ConfigMaps
- EnvVar
- EnvVar represents an environment variable present in a Container.
- EnvVarSource
- EnvVarSource represents a source for the value of an EnvVar.
- ExecAction
- Not supported by Cloud Run ExecAction describes a "run in container" action.
- Execution
- Execution represents the configuration of a single execution.
- ExecutionReference
- Reference to an Execution.
- ExecutionSpec
- ExecutionSpec describes how the execution will look.
- ExecutionStatus
- ExecutionStatus represents the current state of a Execution.
- ExecutionTemplateSpec
- ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job.
- GoogleCloudRunV1Condition
- Condition defines a generic condition for a Resource.
- GRPCAction
- Not supported by Cloud Run GRPCAction describes an action involving a GRPC port.
- HTTPGetAction
- Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests.
- HTTPHeader
- Not supported by Cloud Run HTTPHeader describes a custom header to be used in HTTP probes
- Job
- Job represents the configuration of a single job.
- JobSpec
- JobSpec describes how the job will look.
- JobStatus
- JobStatus represents the current state of a Job.
- KeyToPath
- Maps a string key to a path within a volume.
- ListAuthorizedDomainsResponse
- A list of Authorized Domains.
- ListConfigurationsResponse
- ListConfigurationsResponse is a list of Configuration resources.
- ListDomainMappingsResponse
- ListDomainMappingsResponse is a list of DomainMapping resources.
- ListExecutionsResponse
- ListExecutionsResponse is a list of Executions resources.
- ListJobsResponse
- ListJobsResponse is a list of Jobs resources.
- ListLocationsResponse
- The response message for Locations.ListLocations.
- ListMeta
- ListMeta describes metadata that synthetic resources must have, including lists and various status objects.
- ListRevisionsResponse
- ListRevisionsResponse is a list of Revision resources.
- ListRoutesResponse
- ListRoutesResponse is a list of Route resources.
- ListServicesResponse
- A list of Service resources.
- ListTasksResponse
- ListTasksResponse is a list of Tasks resources.
- LocalObjectReference
- Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
- NamespacesAuthorizeddomainsResource
- NamespacesConfigurationsResource
- NamespacesDomainmappingsResource
- NamespacesExecutionsResource
- NamespacesJobsResource
- NamespacesResource
- NamespacesRevisionsResource
- NamespacesRoutesResource
- NamespacesServicesResource
- NamespacesTasksResource
- ObjectMeta
- k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
- OwnerReference
- OwnerReference contains enough information to let you identify an owning object.
- Policy
- An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
- Probe
- Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
- ProjectsAuthorizeddomainsResource
- ProjectsLocationsAuthorizeddomainsResource
- ProjectsLocationsConfigurationsResource
- ProjectsLocationsDomainmappingsResource
- ProjectsLocationsJobsResource
- ProjectsLocationsResource
- ProjectsLocationsRevisionsResource
- ProjectsLocationsRoutesResource
- ProjectsLocationsServicesResource
- ProjectsResource
- ResourceRecord
- A DNS resource record.
- ResourceRequirements
- ResourceRequirements describes the compute resource requirements.
- Revision
- Revision is an immutable snapshot of code and configuration.
- RevisionSpec
- RevisionSpec holds the desired state of the Revision (from the client).
- RevisionStatus
- RevisionStatus communicates the observed state of the Revision (from the controller).
- RevisionTemplate
- RevisionTemplateSpec describes the data a revision should have when created from a template.
- Route
- Route is responsible for configuring ingress over a collection of Revisions.
- RouteSpec
- RouteSpec holds the desired state of the Route (from the client).
- RouteStatus
- RouteStatus communicates the observed state of the Route (from the controller).
- SecretEnvSource
- Not supported by Cloud Run SecretEnvSource selects a Secret to populate the environment variables with.
- SecretKeySelector
- SecretKeySelector selects a key of a Secret.
- SecretVolumeSource
- The secret's value will be presented as the content of a file whose name is defined in the item path.
- SecurityContext
- Not supported by Cloud Run SecurityContext holds security configuration that will be applied to a container.
- Service
- Service acts as a top-level container that manages a set of Routes and Configurations which implement a network service.
- ServiceSpec
- ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s).
- ServiceStatus
- The current state of the Service.
- SetIamPolicyRequest
-
Request message for
SetIamPolicymethod. - Status
- Status is a return value for calls that don't return other objects
- StatusCause
- StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
- StatusDetails
- StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response.
- Task
- Task represents a single run of a container to completion.
- TaskAttemptResult
- Result of a task attempt.
- TaskSpec
- TaskSpec is a description of a task.
- TaskStatus
- TaskStatus represents the status of a task of a job execution.
- TaskTemplateSpec
- TaskTemplateSpec describes the data a task should have when created from a template.
- TCPSocketAction
- Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket
- TrafficTarget
- TrafficTarget holds a single entry of the routing table for a Route.
- Volume
- Volume represents a named volume in a container.
- VolumeMount
- VolumeMount describes a mounting of a Volume within a container.
Typedefs
- AuditLogConfig = $AuditLogConfig
- Provides the configuration for logging a type of permissions.
- Expr = $Expr
- Represents a textual expression in the Common Expression Language (CEL) syntax.
- GoogleRpcStatus = $Status
-
The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. - Location = $Location00
- A resource that represents Google Cloud Platform location.
- RunJobRequest = $Empty
- Request message for creating a new execution of a job.
- TestIamPermissionsRequest = $TestIamPermissionsRequest00
-
Request message for
TestIamPermissionsmethod. - TestIamPermissionsResponse = $PermissionsResponse
-
Response message for
TestIamPermissionsmethod.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.