Package com.google.cloud.run.v2 (0.18.0)

A client to Cloud Run Admin API

The interfaces provided are listed below, along with usage samples.

ExecutionsClient

Service Description: Cloud Run Execution Control Plane API.

Sample for ExecutionsClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   ExecutionName name = ExecutionName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]");
   Execution response = executionsClient.getExecution(name);
 }

JobsClient

Service Description: Cloud Run Job Control Plane API.

Sample for JobsClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobsClient jobsClient = JobsClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   Job response = jobsClient.getJob(name);
 }

RevisionsClient

Service Description: Cloud Run Revision Control Plane API.

Sample for RevisionsClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RevisionsClient revisionsClient = RevisionsClient.create()) {
   RevisionName name = RevisionName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[REVISION]");
   Revision response = revisionsClient.getRevision(name);
 }

ServicesClient

Service Description: Cloud Run Service Control Plane API

Sample for ServicesClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServicesClient servicesClient = ServicesClient.create()) {
   ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
   Service response = servicesClient.getService(name);
 }

TasksClient

Service Description: Cloud Run Task Control Plane API.

Sample for TasksClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TasksClient tasksClient = TasksClient.create()) {
   TaskName name = TaskName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]", "[TASK]");
   Task response = tasksClient.getTask(name);
 }

Classes

BinaryAuthorization

Settings for Binary Authorization feature.

Protobuf type google.cloud.run.v2.BinaryAuthorization

BinaryAuthorization.Builder

Settings for Binary Authorization feature.

Protobuf type google.cloud.run.v2.BinaryAuthorization

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.

Protobuf type google.cloud.run.v2.CloudSqlInstance

CloudSqlInstance.Builder

Protobuf type google.cloud.run.v2.CloudSqlInstance

Condition

Defines a status condition for a resource.

Protobuf type google.cloud.run.v2.Condition

Condition.Builder

Defines a status condition for a resource.

Protobuf type google.cloud.run.v2.Condition

ConditionProto

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 may be supplied by the system to the container at runtime.

Protobuf type google.cloud.run.v2.Container

Container.Builder

Protobuf type google.cloud.run.v2.Container

ContainerPort

ContainerPort represents a network port in a single container.

Protobuf type google.cloud.run.v2.ContainerPort

ContainerPort.Builder

ContainerPort represents a network port in a single container.

Protobuf type google.cloud.run.v2.ContainerPort

CreateJobRequest

Request message for creating a Job.

Protobuf type google.cloud.run.v2.CreateJobRequest

CreateJobRequest.Builder

Request message for creating a Job.

Protobuf type google.cloud.run.v2.CreateJobRequest

CreateServiceRequest

Request message for creating a Service.

Protobuf type google.cloud.run.v2.CreateServiceRequest

CreateServiceRequest.Builder

Request message for creating a Service.

Protobuf type google.cloud.run.v2.CreateServiceRequest

DeleteExecutionRequest

Request message for deleting an Execution.

Protobuf type google.cloud.run.v2.DeleteExecutionRequest

DeleteExecutionRequest.Builder

Request message for deleting an Execution.

Protobuf type google.cloud.run.v2.DeleteExecutionRequest

DeleteJobRequest

Request message to delete a Job by its full name.

Protobuf type google.cloud.run.v2.DeleteJobRequest

DeleteJobRequest.Builder

Request message to delete a Job by its full name.

Protobuf type google.cloud.run.v2.DeleteJobRequest

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.

Protobuf type google.cloud.run.v2.DeleteRevisionRequest

DeleteRevisionRequest.Builder

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.

Protobuf type google.cloud.run.v2.DeleteRevisionRequest

DeleteServiceRequest

Request message to delete a Service by its full name.

Protobuf type google.cloud.run.v2.DeleteServiceRequest

DeleteServiceRequest.Builder

Request message to delete a Service by its full name.

Protobuf type google.cloud.run.v2.DeleteServiceRequest

EnvVar

EnvVar represents an environment variable present in a Container.

Protobuf type google.cloud.run.v2.EnvVar

EnvVar.Builder

EnvVar represents an environment variable present in a Container.

Protobuf type google.cloud.run.v2.EnvVar

EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Protobuf type google.cloud.run.v2.EnvVarSource

EnvVarSource.Builder

EnvVarSource represents a source for the value of an EnvVar.

Protobuf type google.cloud.run.v2.EnvVarSource

Execution

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

Protobuf type google.cloud.run.v2.Execution

Execution.Builder

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

Protobuf type google.cloud.run.v2.Execution

ExecutionName

ExecutionName.Builder

Builder for projects/{project}/locations/{location}/jobs/{job}/executions/{execution}.

ExecutionProto

ExecutionReference

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

Protobuf type google.cloud.run.v2.ExecutionReference

ExecutionReference.Builder

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

Protobuf type google.cloud.run.v2.ExecutionReference

ExecutionTemplate

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

Protobuf type google.cloud.run.v2.ExecutionTemplate

ExecutionTemplate.Builder

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

Protobuf type google.cloud.run.v2.ExecutionTemplate

ExecutionTemplateProto

ExecutionsClient

Service Description: Cloud Run Execution Control Plane API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ExecutionsClient executionsClient = ExecutionsClient.create()) {
   ExecutionName name = ExecutionName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]");
   Execution response = executionsClient.getExecution(name);
 }

Note: close() needs to be called on the ExecutionsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ExecutionsSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ExecutionsSettings executionsSettings =
     ExecutionsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ExecutionsClient executionsClient = ExecutionsClient.create(executionsSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ExecutionsSettings executionsSettings =
     ExecutionsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ExecutionsClient executionsClient = ExecutionsClient.create(executionsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ExecutionsSettings executionsSettings = ExecutionsSettings.newHttpJsonBuilder().build();
 ExecutionsClient executionsClient = ExecutionsClient.create(executionsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

ExecutionsClient.ListExecutionsFixedSizeCollection

ExecutionsClient.ListExecutionsPage

ExecutionsClient.ListExecutionsPagedResponse

ExecutionsGrpc

Cloud Run Execution Control Plane API.

ExecutionsGrpc.ExecutionsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Executions.

Cloud Run Execution Control Plane API.

ExecutionsGrpc.ExecutionsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Executions.

Cloud Run Execution Control Plane API.

ExecutionsGrpc.ExecutionsImplBase

Base class for the server implementation of the service Executions.

Cloud Run Execution Control Plane API.

ExecutionsGrpc.ExecutionsStub

A stub to allow clients to do asynchronous rpc calls to service Executions.

Cloud Run Execution Control Plane API.

ExecutionsSettings

Settings class to configure an instance of ExecutionsClient.

The default instance has everything set to sensible defaults:

The default service address (run.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getExecution to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ExecutionsSettings.Builder executionsSettingsBuilder = ExecutionsSettings.newBuilder();
 executionsSettingsBuilder
     .getExecutionSettings()
     .setRetrySettings(
         executionsSettingsBuilder
             .getExecutionSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ExecutionsSettings executionsSettings = executionsSettingsBuilder.build();

ExecutionsSettings.Builder

Builder for ExecutionsSettings.

GRPCAction

GRPCAction describes an action involving a GRPC port.

Protobuf type google.cloud.run.v2.GRPCAction

GRPCAction.Builder

GRPCAction describes an action involving a GRPC port.

Protobuf type google.cloud.run.v2.GRPCAction

GetExecutionRequest

Request message for obtaining a Execution by its full name.

Protobuf type google.cloud.run.v2.GetExecutionRequest

GetExecutionRequest.Builder

Request message for obtaining a Execution by its full name.

Protobuf type google.cloud.run.v2.GetExecutionRequest

GetJobRequest

Request message for obtaining a Job by its full name.

Protobuf type google.cloud.run.v2.GetJobRequest

GetJobRequest.Builder

Request message for obtaining a Job by its full name.

Protobuf type google.cloud.run.v2.GetJobRequest

GetRevisionRequest

Request message for obtaining a Revision by its full name.

Protobuf type google.cloud.run.v2.GetRevisionRequest

GetRevisionRequest.Builder

Request message for obtaining a Revision by its full name.

Protobuf type google.cloud.run.v2.GetRevisionRequest

GetServiceRequest

Request message for obtaining a Service by its full name.

Protobuf type google.cloud.run.v2.GetServiceRequest

GetServiceRequest.Builder

Request message for obtaining a Service by its full name.

Protobuf type google.cloud.run.v2.GetServiceRequest

GetTaskRequest

Request message for obtaining a Task by its full name.

Protobuf type google.cloud.run.v2.GetTaskRequest

GetTaskRequest.Builder

Request message for obtaining a Task by its full name.

Protobuf type google.cloud.run.v2.GetTaskRequest

HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Protobuf type google.cloud.run.v2.HTTPGetAction

HTTPGetAction.Builder

HTTPGetAction describes an action based on HTTP Get requests.

Protobuf type google.cloud.run.v2.HTTPGetAction

HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

Protobuf type google.cloud.run.v2.HTTPHeader

HTTPHeader.Builder

HTTPHeader describes a custom header to be used in HTTP probes

Protobuf type google.cloud.run.v2.HTTPHeader

Job

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

Protobuf type google.cloud.run.v2.Job

Job.Builder

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

Protobuf type google.cloud.run.v2.Job

JobName

JobName.Builder

Builder for projects/{project}/locations/{location}/jobs/{job}.

JobProto

JobsClient

Service Description: Cloud Run Job Control Plane API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobsClient jobsClient = JobsClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   Job response = jobsClient.getJob(name);
 }

Note: close() needs to be called on the JobsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of JobsSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 JobsSettings jobsSettings =
     JobsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 JobsClient jobsClient = JobsClient.create(jobsSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 JobsSettings jobsSettings = JobsSettings.newBuilder().setEndpoint(myEndpoint).build();
 JobsClient jobsClient = JobsClient.create(jobsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 JobsSettings jobsSettings = JobsSettings.newHttpJsonBuilder().build();
 JobsClient jobsClient = JobsClient.create(jobsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

JobsClient.ListJobsFixedSizeCollection

JobsClient.ListJobsPage

JobsClient.ListJobsPagedResponse

JobsGrpc

Cloud Run Job Control Plane API.

JobsGrpc.JobsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Jobs.

Cloud Run Job Control Plane API.

JobsGrpc.JobsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Jobs.

Cloud Run Job Control Plane API.

JobsGrpc.JobsImplBase

Base class for the server implementation of the service Jobs.

Cloud Run Job Control Plane API.

JobsGrpc.JobsStub

A stub to allow clients to do asynchronous rpc calls to service Jobs.

Cloud Run Job Control Plane API.

JobsSettings

Settings class to configure an instance of JobsClient.

The default instance has everything set to sensible defaults:

The default service address (run.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getJob to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 JobsSettings.Builder jobsSettingsBuilder = JobsSettings.newBuilder();
 jobsSettingsBuilder
     .getJobSettings()
     .setRetrySettings(
         jobsSettingsBuilder
             .getJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 JobsSettings jobsSettings = jobsSettingsBuilder.build();

JobsSettings.Builder

Builder for JobsSettings.

K8sMinProto

ListExecutionsRequest

Request message for retrieving a list of Executions.

Protobuf type google.cloud.run.v2.ListExecutionsRequest

ListExecutionsRequest.Builder

Request message for retrieving a list of Executions.

Protobuf type google.cloud.run.v2.ListExecutionsRequest

ListExecutionsResponse

Response message containing a list of Executions.

Protobuf type google.cloud.run.v2.ListExecutionsResponse

ListExecutionsResponse.Builder

Response message containing a list of Executions.

Protobuf type google.cloud.run.v2.ListExecutionsResponse

ListJobsRequest

Request message for retrieving a list of Jobs.

Protobuf type google.cloud.run.v2.ListJobsRequest

ListJobsRequest.Builder

Request message for retrieving a list of Jobs.

Protobuf type google.cloud.run.v2.ListJobsRequest

ListJobsResponse

Response message containing a list of Jobs.

Protobuf type google.cloud.run.v2.ListJobsResponse

ListJobsResponse.Builder

Response message containing a list of Jobs.

Protobuf type google.cloud.run.v2.ListJobsResponse

ListRevisionsRequest

Request message for retrieving a list of Revisions.

Protobuf type google.cloud.run.v2.ListRevisionsRequest

ListRevisionsRequest.Builder

Request message for retrieving a list of Revisions.

Protobuf type google.cloud.run.v2.ListRevisionsRequest

ListRevisionsResponse

Response message containing a list of Revisions.

Protobuf type google.cloud.run.v2.ListRevisionsResponse

ListRevisionsResponse.Builder

Response message containing a list of Revisions.

Protobuf type google.cloud.run.v2.ListRevisionsResponse

ListServicesRequest

Request message for retrieving a list of Services.

Protobuf type google.cloud.run.v2.ListServicesRequest

ListServicesRequest.Builder

Request message for retrieving a list of Services.

Protobuf type google.cloud.run.v2.ListServicesRequest

ListServicesResponse

Response message containing a list of Services.

Protobuf type google.cloud.run.v2.ListServicesResponse

ListServicesResponse.Builder

Response message containing a list of Services.

Protobuf type google.cloud.run.v2.ListServicesResponse

ListTasksRequest

Request message for retrieving a list of Tasks.

Protobuf type google.cloud.run.v2.ListTasksRequest

ListTasksRequest.Builder

Request message for retrieving a list of Tasks.

Protobuf type google.cloud.run.v2.ListTasksRequest

ListTasksResponse

Response message containing a list of Tasks.

Protobuf type google.cloud.run.v2.ListTasksResponse

ListTasksResponse.Builder

Response message containing a list of Tasks.

Protobuf type google.cloud.run.v2.ListTasksResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

Probe

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

Protobuf type google.cloud.run.v2.Probe

Probe.Builder

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

Protobuf type google.cloud.run.v2.Probe

ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Protobuf type google.cloud.run.v2.ResourceRequirements

ResourceRequirements.Builder

ResourceRequirements describes the compute resource requirements.

Protobuf type google.cloud.run.v2.ResourceRequirements

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.

Protobuf type google.cloud.run.v2.Revision

Revision.Builder

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.

Protobuf type google.cloud.run.v2.Revision

RevisionName

RevisionName.Builder

Builder for projects/{project}/locations/{location}/services/{service}/revisions/{revision}.

RevisionProto

RevisionScaling

Settings for revision-level scaling settings.

Protobuf type google.cloud.run.v2.RevisionScaling

RevisionScaling.Builder

Settings for revision-level scaling settings.

Protobuf type google.cloud.run.v2.RevisionScaling

RevisionTemplate

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

Protobuf type google.cloud.run.v2.RevisionTemplate

RevisionTemplate.Builder

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

Protobuf type google.cloud.run.v2.RevisionTemplate

RevisionTemplateProto

RevisionsClient

Service Description: Cloud Run Revision Control Plane API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RevisionsClient revisionsClient = RevisionsClient.create()) {
   RevisionName name = RevisionName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[REVISION]");
   Revision response = revisionsClient.getRevision(name);
 }

Note: close() needs to be called on the RevisionsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of RevisionsSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 RevisionsSettings revisionsSettings =
     RevisionsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RevisionsClient revisionsClient = RevisionsClient.create(revisionsSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 RevisionsSettings revisionsSettings =
     RevisionsSettings.newBuilder().setEndpoint(myEndpoint).build();
 RevisionsClient revisionsClient = RevisionsClient.create(revisionsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 RevisionsSettings revisionsSettings = RevisionsSettings.newHttpJsonBuilder().build();
 RevisionsClient revisionsClient = RevisionsClient.create(revisionsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

RevisionsClient.ListRevisionsFixedSizeCollection

RevisionsClient.ListRevisionsPage

RevisionsClient.ListRevisionsPagedResponse

RevisionsGrpc

Cloud Run Revision Control Plane API.

RevisionsGrpc.RevisionsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Revisions.

Cloud Run Revision Control Plane API.

RevisionsGrpc.RevisionsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Revisions.

Cloud Run Revision Control Plane API.

RevisionsGrpc.RevisionsImplBase

Base class for the server implementation of the service Revisions.

Cloud Run Revision Control Plane API.

RevisionsGrpc.RevisionsStub

A stub to allow clients to do asynchronous rpc calls to service Revisions.

Cloud Run Revision Control Plane API.

RevisionsSettings

Settings class to configure an instance of RevisionsClient.

The default instance has everything set to sensible defaults:

The default service address (run.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getRevision to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 RevisionsSettings.Builder revisionsSettingsBuilder = RevisionsSettings.newBuilder();
 revisionsSettingsBuilder
     .getRevisionSettings()
     .setRetrySettings(
         revisionsSettingsBuilder
             .getRevisionSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 RevisionsSettings revisionsSettings = revisionsSettingsBuilder.build();

RevisionsSettings.Builder

Builder for RevisionsSettings.

RunJobRequest

Request message to create a new Execution of a Job.

Protobuf type google.cloud.run.v2.RunJobRequest

RunJobRequest.Builder

Request message to create a new Execution of a Job.

Protobuf type google.cloud.run.v2.RunJobRequest

SecretKeySelector

SecretEnvVarSource represents a source for the value of an EnvVar.

Protobuf type google.cloud.run.v2.SecretKeySelector

SecretKeySelector.Builder

SecretEnvVarSource represents a source for the value of an EnvVar.

Protobuf type google.cloud.run.v2.SecretKeySelector

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.

Protobuf type google.cloud.run.v2.SecretVolumeSource

SecretVolumeSource.Builder

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.

Protobuf type google.cloud.run.v2.SecretVolumeSource

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.

Protobuf type google.cloud.run.v2.Service

Service.Builder

Protobuf type google.cloud.run.v2.Service

ServiceName

ServiceName.Builder

Builder for projects/{project}/locations/{location}/services/{service}.

ServiceProto

ServicesClient

Service Description: Cloud Run Service Control Plane API

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServicesClient servicesClient = ServicesClient.create()) {
   ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
   Service response = servicesClient.getService(name);
 }

Note: close() needs to be called on the ServicesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of ServicesSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ServicesSettings servicesSettings =
     ServicesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ServicesClient servicesClient = ServicesClient.create(servicesSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ServicesSettings servicesSettings =
     ServicesSettings.newBuilder().setEndpoint(myEndpoint).build();
 ServicesClient servicesClient = ServicesClient.create(servicesSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ServicesSettings servicesSettings = ServicesSettings.newHttpJsonBuilder().build();
 ServicesClient servicesClient = ServicesClient.create(servicesSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

ServicesClient.ListServicesFixedSizeCollection

ServicesClient.ListServicesPage

ServicesClient.ListServicesPagedResponse

ServicesGrpc

Cloud Run Service Control Plane API

ServicesGrpc.ServicesBlockingStub

A stub to allow clients to do synchronous rpc calls to service Services.

Cloud Run Service Control Plane API

ServicesGrpc.ServicesFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Services.

Cloud Run Service Control Plane API

ServicesGrpc.ServicesImplBase

Base class for the server implementation of the service Services.

Cloud Run Service Control Plane API

ServicesGrpc.ServicesStub

A stub to allow clients to do asynchronous rpc calls to service Services.

Cloud Run Service Control Plane API

ServicesSettings

Settings class to configure an instance of ServicesClient.

The default instance has everything set to sensible defaults:

The default service address (run.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getService to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ServicesSettings.Builder servicesSettingsBuilder = ServicesSettings.newBuilder();
 servicesSettingsBuilder
     .getServiceSettings()
     .setRetrySettings(
         servicesSettingsBuilder
             .getServiceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ServicesSettings servicesSettings = servicesSettingsBuilder.build();

ServicesSettings.Builder

Builder for ServicesSettings.

TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Protobuf type google.cloud.run.v2.TCPSocketAction

TCPSocketAction.Builder

TCPSocketAction describes an action based on opening a socket

Protobuf type google.cloud.run.v2.TCPSocketAction

Task

Task represents a single run of a container to completion.

Protobuf type google.cloud.run.v2.Task

Task.Builder

Task represents a single run of a container to completion.

Protobuf type google.cloud.run.v2.Task

TaskAttemptResult

Result of a task attempt.

Protobuf type google.cloud.run.v2.TaskAttemptResult

TaskAttemptResult.Builder

Result of a task attempt.

Protobuf type google.cloud.run.v2.TaskAttemptResult

TaskName

TaskName.Builder

Builder for projects/{project}/locations/{location}/jobs/{job}/executions/{execution}/tasks/{task}.

TaskProto

TaskTemplate

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

Protobuf type google.cloud.run.v2.TaskTemplate

TaskTemplate.Builder

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

Protobuf type google.cloud.run.v2.TaskTemplate

TaskTemplateProto

TasksClient

Service Description: Cloud Run Task Control Plane API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TasksClient tasksClient = TasksClient.create()) {
   TaskName name = TaskName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]", "[TASK]");
   Task response = tasksClient.getTask(name);
 }

Note: close() needs to be called on the TasksClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of TasksSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TasksSettings tasksSettings =
     TasksSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TasksClient tasksClient = TasksClient.create(tasksSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TasksSettings tasksSettings = TasksSettings.newBuilder().setEndpoint(myEndpoint).build();
 TasksClient tasksClient = TasksClient.create(tasksSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TasksSettings tasksSettings = TasksSettings.newHttpJsonBuilder().build();
 TasksClient tasksClient = TasksClient.create(tasksSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

TasksClient.ListTasksFixedSizeCollection

TasksClient.ListTasksPage

TasksClient.ListTasksPagedResponse

TasksGrpc

Cloud Run Task Control Plane API.

TasksGrpc.TasksBlockingStub

A stub to allow clients to do synchronous rpc calls to service Tasks.

Cloud Run Task Control Plane API.

TasksGrpc.TasksFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Tasks.

Cloud Run Task Control Plane API.

TasksGrpc.TasksImplBase

Base class for the server implementation of the service Tasks.

Cloud Run Task Control Plane API.

TasksGrpc.TasksStub

A stub to allow clients to do asynchronous rpc calls to service Tasks.

Cloud Run Task Control Plane API.

TasksSettings

Settings class to configure an instance of TasksClient.

The default instance has everything set to sensible defaults:

The default service address (run.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getTask to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TasksSettings.Builder tasksSettingsBuilder = TasksSettings.newBuilder();
 tasksSettingsBuilder
     .getTaskSettings()
     .setRetrySettings(
         tasksSettingsBuilder
             .getTaskSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TasksSettings tasksSettings = tasksSettingsBuilder.build();

VPC Access settings. For more information on creating a VPC Connector, visit https://cloud.google.com/vpc/docs/configure-serverless-vpc-access For information on how to configure Cloud Run with an existing VPC Connector, visit https://cloud.google.com/run/docs/configuring/connecting-vpc

Protobuf type google.cloud.run.v2.VpcAccess

VpcAccess.Builder

Protobuf type google.cloud.run.v2.VpcAccess