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

Settings for Binary Authorization feature.

Protobuf type google.cloud.run.v2.BinaryAuthorization

Settings for Binary Authorization feature.

Protobuf type google.cloud.run.v2.BinaryAuthorization

Represents a specific Cloud SQL instance.

Protobuf type google.cloud.run.v2.CloudSqlInstance

Represents a specific Cloud SQL instance.

Protobuf type google.cloud.run.v2.CloudSqlInstance

Defines a status condition for a resource.

Protobuf type google.cloud.run.v2.Condition

Defines a status condition for a resource.

Protobuf type google.cloud.run.v2.Condition

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

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

ContainerPort represents a network port in a single container.

Protobuf type google.cloud.run.v2.ContainerPort

ContainerPort represents a network port in a single container.

Protobuf type google.cloud.run.v2.ContainerPort

Request message for creating a Job.

Protobuf type google.cloud.run.v2.CreateJobRequest

Request message for creating a Job.

Protobuf type google.cloud.run.v2.CreateJobRequest

Request message for creating a Service.

Protobuf type google.cloud.run.v2.CreateServiceRequest

Request message for creating a Service.

Protobuf type google.cloud.run.v2.CreateServiceRequest

Request message for deleting an Execution.

Protobuf type google.cloud.run.v2.DeleteExecutionRequest

Request message for deleting an Execution.

Protobuf type google.cloud.run.v2.DeleteExecutionRequest

Request message to delete a Job by its full name.

Protobuf type google.cloud.run.v2.DeleteJobRequest

Request message to delete a Job by its full name.

Protobuf type google.cloud.run.v2.DeleteJobRequest

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

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

Request message to delete a Service by its full name.

Protobuf type google.cloud.run.v2.DeleteServiceRequest

Request message to delete a Service by its full name.

Protobuf type google.cloud.run.v2.DeleteServiceRequest

EnvVar represents an environment variable present in a Container.

Protobuf type google.cloud.run.v2.EnvVar

EnvVar represents an environment variable present in a Container.

Protobuf type google.cloud.run.v2.EnvVar

EnvVarSource represents a source for the value of an EnvVar.

Protobuf type google.cloud.run.v2.EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Protobuf type google.cloud.run.v2.EnvVarSource

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 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

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

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

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 describes the data an execution should have when created from a template.

Protobuf type google.cloud.run.v2.ExecutionTemplate

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

Protobuf type google.cloud.run.v2.ExecutionTemplate

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:

1. 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.
2. 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.
3. 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.

Cloud Run Execution Control Plane API.

Cloud Run Execution Control Plane API.

Cloud Run Execution Control Plane API.

Cloud Run Execution Control Plane API.

Cloud Run Execution Control Plane API.

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();
 

Builder for ExecutionsSettings.

GRPCAction describes an action involving a GRPC port.

Protobuf type google.cloud.run.v2.GRPCAction

GRPCAction describes an action involving a GRPC port.

Protobuf type google.cloud.run.v2.GRPCAction

Request message for obtaining a Execution by its full name.

Protobuf type google.cloud.run.v2.GetExecutionRequest

Request message for obtaining a Execution by its full name.

Protobuf type google.cloud.run.v2.GetExecutionRequest

Request message for obtaining a Job by its full name.

Protobuf type google.cloud.run.v2.GetJobRequest

Request message for obtaining a Job by its full name.

Protobuf type google.cloud.run.v2.GetJobRequest

Request message for obtaining a Revision by its full name.

Protobuf type google.cloud.run.v2.GetRevisionRequest

Request message for obtaining a Revision by its full name.

Protobuf type google.cloud.run.v2.GetRevisionRequest

Request message for obtaining a Service by its full name.

Protobuf type google.cloud.run.v2.GetServiceRequest

Request message for obtaining a Service by its full name.

Protobuf type google.cloud.run.v2.GetServiceRequest

Request message for obtaining a Task by its full name.

Protobuf type google.cloud.run.v2.GetTaskRequest

Request message for obtaining a Task by its full name.

Protobuf type google.cloud.run.v2.GetTaskRequest

HTTPGetAction describes an action based on HTTP Get requests.

Protobuf type google.cloud.run.v2.HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Protobuf type google.cloud.run.v2.HTTPGetAction

HTTPHeader describes a custom header to be used in HTTP probes

Protobuf type google.cloud.run.v2.HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

Protobuf type google.cloud.run.v2.HTTPHeader

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

Protobuf type google.cloud.run.v2.Job

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

Protobuf type google.cloud.run.v2.Job

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

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:

1. 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.
2. 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.
3. 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 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.

Cloud Run Job Control Plane API.

Cloud Run Job Control Plane API.

Cloud Run Job Control Plane API.

Cloud Run Job Control Plane API.

Cloud Run Job Control Plane API.

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();
 

Builder for JobsSettings.

Request message for retrieving a list of Executions.

Protobuf type google.cloud.run.v2.ListExecutionsRequest

Request message for retrieving a list of Executions.

Protobuf type google.cloud.run.v2.ListExecutionsRequest

Response message containing a list of Executions.

Protobuf type google.cloud.run.v2.ListExecutionsResponse

Response message containing a list of Executions.

Protobuf type google.cloud.run.v2.ListExecutionsResponse

Request message for retrieving a list of Jobs.

Protobuf type google.cloud.run.v2.ListJobsRequest

Request message for retrieving a list of Jobs.

Protobuf type google.cloud.run.v2.ListJobsRequest

Response message containing a list of Jobs.

Protobuf type google.cloud.run.v2.ListJobsResponse

Response message containing a list of Jobs.

Protobuf type google.cloud.run.v2.ListJobsResponse

Request message for retrieving a list of Revisions.

Protobuf type google.cloud.run.v2.ListRevisionsRequest

Request message for retrieving a list of Revisions.

Protobuf type google.cloud.run.v2.ListRevisionsRequest

Response message containing a list of Revisions.

Protobuf type google.cloud.run.v2.ListRevisionsResponse

Response message containing a list of Revisions.

Protobuf type google.cloud.run.v2.ListRevisionsResponse

Request message for retrieving a list of Services.

Protobuf type google.cloud.run.v2.ListServicesRequest

Request message for retrieving a list of Services.

Protobuf type google.cloud.run.v2.ListServicesRequest

Response message containing a list of Services.

Protobuf type google.cloud.run.v2.ListServicesResponse

Response message containing a list of Services.

Protobuf type google.cloud.run.v2.ListServicesResponse

Request message for retrieving a list of Tasks.

Protobuf type google.cloud.run.v2.ListTasksRequest

Request message for retrieving a list of Tasks.

Protobuf type google.cloud.run.v2.ListTasksRequest

Response message containing a list of Tasks.

Protobuf type google.cloud.run.v2.ListTasksResponse

Response message containing a list of Tasks.

Protobuf type google.cloud.run.v2.ListTasksResponse

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

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 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 describes the compute resource requirements.

Protobuf type google.cloud.run.v2.ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Protobuf type google.cloud.run.v2.ResourceRequirements

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

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

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

Settings for revision-level scaling settings.

Protobuf type google.cloud.run.v2.RevisionScaling

Settings for revision-level scaling settings.

Protobuf type google.cloud.run.v2.RevisionScaling

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

Protobuf type google.cloud.run.v2.RevisionTemplate

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

Protobuf type google.cloud.run.v2.RevisionTemplate

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:

1. 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.
2. 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.
3. 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 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.

Cloud Run Revision Control Plane API.

Cloud Run Revision Control Plane API.

Cloud Run Revision Control Plane API.

Cloud Run Revision Control Plane API.

Cloud Run Revision Control Plane API.

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();
 

Builder for RevisionsSettings.

Request message to create a new Execution of a Job.

Protobuf type google.cloud.run.v2.RunJobRequest

Request message to create a new Execution of a Job.

Protobuf type google.cloud.run.v2.RunJobRequest

SecretEnvVarSource represents a source for the value of an EnvVar.

Protobuf type google.cloud.run.v2.SecretKeySelector

SecretEnvVarSource represents a source for the value of an EnvVar.

Protobuf type google.cloud.run.v2.SecretKeySelector

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

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 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 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

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

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:

1. 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.
2. 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.
3. 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 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.

Cloud Run Service Control Plane API

Cloud Run Service Control Plane API

Cloud Run Service Control Plane API

Cloud Run Service Control Plane API

Cloud Run Service Control Plane API

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();
 

Builder for ServicesSettings.

TCPSocketAction describes an action based on opening a socket

Protobuf type google.cloud.run.v2.TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Protobuf type google.cloud.run.v2.TCPSocketAction

Task represents a single run of a container to completion.

Protobuf type google.cloud.run.v2.Task

Task represents a single run of a container to completion.

Protobuf type google.cloud.run.v2.Task

Result of a task attempt.

Protobuf type google.cloud.run.v2.TaskAttemptResult

Result of a task attempt.

Protobuf type google.cloud.run.v2.TaskAttemptResult

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

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

Protobuf type google.cloud.run.v2.TaskTemplate

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

Protobuf type google.cloud.run.v2.TaskTemplate

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:

1. 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.
2. 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.
3. 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 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.

Cloud Run Task Control Plane API.

Cloud Run Task Control Plane API.

Cloud Run Task Control Plane API.

Cloud Run Task Control Plane API.

Cloud Run Task Control Plane API.

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();
 

Builder for TasksSettings.

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.

Protobuf type google.cloud.run.v2.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.

Protobuf type google.cloud.run.v2.TrafficTarget

Represents the observed state of a single TrafficTarget entry.

Protobuf type google.cloud.run.v2.TrafficTargetStatus

Represents the observed state of a single TrafficTarget entry.

Protobuf type google.cloud.run.v2.TrafficTargetStatus

Request message for updating a Job.

Protobuf type google.cloud.run.v2.UpdateJobRequest

Request message for updating a Job.

Protobuf type google.cloud.run.v2.UpdateJobRequest

Request message for updating a service.

Protobuf type google.cloud.run.v2.UpdateServiceRequest

Request message for updating a service.

Protobuf type google.cloud.run.v2.UpdateServiceRequest

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

Protobuf type google.cloud.run.v2.VersionToPath

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

Protobuf type google.cloud.run.v2.VersionToPath

Volume represents a named volume in a container.

Protobuf type google.cloud.run.v2.Volume

Volume represents a named volume in a container.

Protobuf type google.cloud.run.v2.Volume

VolumeMount describes a mounting of a Volume within a container.

Protobuf type google.cloud.run.v2.VolumeMount

VolumeMount describes a mounting of a Volume within a container.

Protobuf type google.cloud.run.v2.VolumeMount

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

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

Reasons common to all types of conditions.

Protobuf enum google.cloud.run.v2.Condition.CommonReason

Reasons specific to Execution resource.

Protobuf enum google.cloud.run.v2.Condition.ExecutionReason

Reasons specific to Revision resource.

Protobuf enum google.cloud.run.v2.Condition.RevisionReason

Represents the severity of the condition failures.

Protobuf enum google.cloud.run.v2.Condition.Severity

Represents the possible Condition states.

Protobuf enum google.cloud.run.v2.Condition.State

Alternatives for execution environments.

Protobuf enum google.cloud.run.v2.ExecutionEnvironment

Allowed ingress traffic for the Container.

Protobuf enum google.cloud.run.v2.IngressTraffic

The type of instance allocation.

Protobuf enum google.cloud.run.v2.TrafficTargetAllocationType

Egress options for VPC access.

Protobuf enum google.cloud.run.v2.VpcAccess.VpcEgress