- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
GitHub Repository | Product Reference | REST Documentation | RPC Documentation |
Service Description: A service for creating and managing Vertex AI's pipelines. This includes
both TrainingPipeline
resources (used for AutoML and custom training) and PipelineJob
resources (used for Vertex AI Pipelines).
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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
TrainingPipeline trainingPipeline = TrainingPipeline.newBuilder().build();
TrainingPipeline response =
pipelineServiceClient.createTrainingPipeline(parent, trainingPipeline);
}
Note: close() needs to be called on the PipelineServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
Method | Description | Method Variants |
---|---|---|
CreateTrainingPipeline | Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetTrainingPipeline | Gets a TrainingPipeline. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListTrainingPipelines | Lists TrainingPipelines in a Location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteTrainingPipeline | Deletes a TrainingPipeline. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CancelTrainingPipeline | Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreatePipelineJob | Creates a PipelineJob. A PipelineJob will run immediately when created. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetPipelineJob | Gets a PipelineJob. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListPipelineJobs | Lists PipelineJobs in a Location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeletePipelineJob | Deletes a PipelineJob. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CancelPipelineJob | Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListLocations | Lists information about the supported locations for this service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation | Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy | Sets the access control policy on the specified resource. Replacesany existing policy. Can return |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetIamPolicy | Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
TestIamPermissions | Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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 PipelineServiceSettings 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
PipelineServiceSettings pipelineServiceSettings =
PipelineServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
PipelineServiceClient pipelineServiceClient =
PipelineServiceClient.create(pipelineServiceSettings);
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
PipelineServiceSettings pipelineServiceSettings =
PipelineServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
PipelineServiceClient pipelineServiceClient =
PipelineServiceClient.create(pipelineServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final PipelineServiceClient create()
Constructs an instance of PipelineServiceClient with default settings.
Returns | |
---|---|
Type | Description |
PipelineServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(PipelineServiceSettings settings)
public static final PipelineServiceClient create(PipelineServiceSettings settings)
Constructs an instance of PipelineServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Parameter | |
---|---|
Name | Description |
settings | PipelineServiceSettings |
Returns | |
---|---|
Type | Description |
PipelineServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(PipelineServiceStub stub)
public static final PipelineServiceClient create(PipelineServiceStub stub)
Constructs an instance of PipelineServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(PipelineServiceSettings).
Parameter | |
---|---|
Name | Description |
stub | PipelineServiceStub |
Returns | |
---|---|
Type | Description |
PipelineServiceClient |
Constructors
PipelineServiceClient(PipelineServiceSettings settings)
protected PipelineServiceClient(PipelineServiceSettings settings)
Constructs an instance of PipelineServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Parameter | |
---|---|
Name | Description |
settings | PipelineServiceSettings |
PipelineServiceClient(PipelineServiceStub stub)
protected PipelineServiceClient(PipelineServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub | PipelineServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration | long |
unit | TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
cancelPipelineJob(CancelPipelineJobRequest request)
public final void cancelPipelineJob(CancelPipelineJobRequest request)
Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a
best effort to cancel the pipeline, but success is not guaranteed. Clients can use
PipelineService.GetPipelineJob or
other methods to check whether the cancellation succeeded or whether the pipeline completed
despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it
becomes a pipeline with a PipelineJob.error
value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED
, and PipelineJob.state is set
to CANCELLED
.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
CancelPipelineJobRequest request =
CancelPipelineJobRequest.newBuilder()
.setName(PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString())
.build();
pipelineServiceClient.cancelPipelineJob(request);
}
Parameter | |
---|---|
Name | Description |
request | CancelPipelineJobRequest The request object containing all of the parameters for the API call. |
cancelPipelineJob(PipelineJobName name)
public final void cancelPipelineJob(PipelineJobName name)
Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a
best effort to cancel the pipeline, but success is not guaranteed. Clients can use
PipelineService.GetPipelineJob or
other methods to check whether the cancellation succeeded or whether the pipeline completed
despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it
becomes a pipeline with a PipelineJob.error
value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED
, and PipelineJob.state is set
to CANCELLED
.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
PipelineJobName name = PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]");
pipelineServiceClient.cancelPipelineJob(name);
}
Parameter | |
---|---|
Name | Description |
name | PipelineJobName Required. The name of the PipelineJob to cancel. Format:
|
cancelPipelineJob(String name)
public final void cancelPipelineJob(String name)
Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a
best effort to cancel the pipeline, but success is not guaranteed. Clients can use
PipelineService.GetPipelineJob or
other methods to check whether the cancellation succeeded or whether the pipeline completed
despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it
becomes a pipeline with a PipelineJob.error
value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED
, and PipelineJob.state is set
to CANCELLED
.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
String name = PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString();
pipelineServiceClient.cancelPipelineJob(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the PipelineJob to cancel. Format:
|
cancelPipelineJobCallable()
public final UnaryCallable<CancelPipelineJobRequest,Empty> cancelPipelineJobCallable()
Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a
best effort to cancel the pipeline, but success is not guaranteed. Clients can use
PipelineService.GetPipelineJob or
other methods to check whether the cancellation succeeded or whether the pipeline completed
despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it
becomes a pipeline with a PipelineJob.error
value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED
, and PipelineJob.state is set
to CANCELLED
.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
CancelPipelineJobRequest request =
CancelPipelineJobRequest.newBuilder()
.setName(PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString())
.build();
ApiFuture<Empty> future =
pipelineServiceClient.cancelPipelineJobCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CancelPipelineJobRequest,Empty> |
cancelTrainingPipeline(CancelTrainingPipelineRequest request)
public final void cancelTrainingPipeline(CancelTrainingPipelineRequest request)
Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The
server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can
use
PipelineService.GetTrainingPipeline
or other methods to check whether the cancellation succeeded or whether the pipeline completed
despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead
it becomes a pipeline with a
TrainingPipeline.error value with a
google.rpc.Status.code of 1, corresponding to Code.CANCELLED
, and
TrainingPipeline.state is set to
CANCELLED
.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
CancelTrainingPipelineRequest request =
CancelTrainingPipelineRequest.newBuilder()
.setName(
TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
.toString())
.build();
pipelineServiceClient.cancelTrainingPipeline(request);
}
Parameter | |
---|---|
Name | Description |
request | CancelTrainingPipelineRequest The request object containing all of the parameters for the API call. |
cancelTrainingPipeline(TrainingPipelineName name)
public final void cancelTrainingPipeline(TrainingPipelineName name)
Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The
server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can
use
PipelineService.GetTrainingPipeline
or other methods to check whether the cancellation succeeded or whether the pipeline completed
despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead
it becomes a pipeline with a
TrainingPipeline.error value with a
google.rpc.Status.code of 1, corresponding to Code.CANCELLED
, and
TrainingPipeline.state is set to
CANCELLED
.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
TrainingPipelineName name =
TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]");
pipelineServiceClient.cancelTrainingPipeline(name);
}
Parameter | |
---|---|
Name | Description |
name | TrainingPipelineName Required. The name of the TrainingPipeline to cancel. Format:
|
cancelTrainingPipeline(String name)
public final void cancelTrainingPipeline(String name)
Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The
server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can
use
PipelineService.GetTrainingPipeline
or other methods to check whether the cancellation succeeded or whether the pipeline completed
despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead
it becomes a pipeline with a
TrainingPipeline.error value with a
google.rpc.Status.code of 1, corresponding to Code.CANCELLED
, and
TrainingPipeline.state is set to
CANCELLED
.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
String name =
TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]").toString();
pipelineServiceClient.cancelTrainingPipeline(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the TrainingPipeline to cancel. Format:
|
cancelTrainingPipelineCallable()
public final UnaryCallable<CancelTrainingPipelineRequest,Empty> cancelTrainingPipelineCallable()
Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The
server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can
use
PipelineService.GetTrainingPipeline
or other methods to check whether the cancellation succeeded or whether the pipeline completed
despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead
it becomes a pipeline with a
TrainingPipeline.error value with a
google.rpc.Status.code of 1, corresponding to Code.CANCELLED
, and
TrainingPipeline.state is set to
CANCELLED
.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
CancelTrainingPipelineRequest request =
CancelTrainingPipelineRequest.newBuilder()
.setName(
TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
.toString())
.build();
ApiFuture<Empty> future =
pipelineServiceClient.cancelTrainingPipelineCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CancelTrainingPipelineRequest,Empty> |
close()
public final void close()
createPipelineJob(CreatePipelineJobRequest request)
public final PipelineJob createPipelineJob(CreatePipelineJobRequest request)
Creates a PipelineJob. A PipelineJob will run immediately when created.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
CreatePipelineJobRequest request =
CreatePipelineJobRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPipelineJob(PipelineJob.newBuilder().build())
.setPipelineJobId("pipelineJobId-1711315914")
.build();
PipelineJob response = pipelineServiceClient.createPipelineJob(request);
}
Parameter | |
---|---|
Name | Description |
request | CreatePipelineJobRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
PipelineJob |
createPipelineJob(LocationName parent, PipelineJob pipelineJob, String pipelineJobId)
public final PipelineJob createPipelineJob(LocationName parent, PipelineJob pipelineJob, String pipelineJobId)
Creates a PipelineJob. A PipelineJob will run immediately when created.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
PipelineJob pipelineJob = PipelineJob.newBuilder().build();
String pipelineJobId = "pipelineJobId-1711315914";
PipelineJob response =
pipelineServiceClient.createPipelineJob(parent, pipelineJob, pipelineJobId);
}
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the PipelineJob in. Format:
|
pipelineJob | PipelineJob Required. The PipelineJob to create. |
pipelineJobId | String The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are |
Returns | |
---|---|
Type | Description |
PipelineJob |
createPipelineJob(String parent, PipelineJob pipelineJob, String pipelineJobId)
public final PipelineJob createPipelineJob(String parent, PipelineJob pipelineJob, String pipelineJobId)
Creates a PipelineJob. A PipelineJob will run immediately when created.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
PipelineJob pipelineJob = PipelineJob.newBuilder().build();
String pipelineJobId = "pipelineJobId-1711315914";
PipelineJob response =
pipelineServiceClient.createPipelineJob(parent, pipelineJob, pipelineJobId);
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The resource name of the Location to create the PipelineJob in. Format:
|
pipelineJob | PipelineJob Required. The PipelineJob to create. |
pipelineJobId | String The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are |
Returns | |
---|---|
Type | Description |
PipelineJob |
createPipelineJobCallable()
public final UnaryCallable<CreatePipelineJobRequest,PipelineJob> createPipelineJobCallable()
Creates a PipelineJob. A PipelineJob will run immediately when created.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
CreatePipelineJobRequest request =
CreatePipelineJobRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPipelineJob(PipelineJob.newBuilder().build())
.setPipelineJobId("pipelineJobId-1711315914")
.build();
ApiFuture<PipelineJob> future =
pipelineServiceClient.createPipelineJobCallable().futureCall(request);
// Do something.
PipelineJob response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreatePipelineJobRequest,PipelineJob> |
createTrainingPipeline(CreateTrainingPipelineRequest request)
public final TrainingPipeline createTrainingPipeline(CreateTrainingPipelineRequest request)
Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
CreateTrainingPipelineRequest request =
CreateTrainingPipelineRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setTrainingPipeline(TrainingPipeline.newBuilder().build())
.build();
TrainingPipeline response = pipelineServiceClient.createTrainingPipeline(request);
}
Parameter | |
---|---|
Name | Description |
request | CreateTrainingPipelineRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
TrainingPipeline |
createTrainingPipeline(LocationName parent, TrainingPipeline trainingPipeline)
public final TrainingPipeline createTrainingPipeline(LocationName parent, TrainingPipeline trainingPipeline)
Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
TrainingPipeline trainingPipeline = TrainingPipeline.newBuilder().build();
TrainingPipeline response =
pipelineServiceClient.createTrainingPipeline(parent, trainingPipeline);
}
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the TrainingPipeline in.
Format: |
trainingPipeline | TrainingPipeline Required. The TrainingPipeline to create. |
Returns | |
---|---|
Type | Description |
TrainingPipeline |
createTrainingPipeline(String parent, TrainingPipeline trainingPipeline)
public final TrainingPipeline createTrainingPipeline(String parent, TrainingPipeline trainingPipeline)
Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
TrainingPipeline trainingPipeline = TrainingPipeline.newBuilder().build();
TrainingPipeline response =
pipelineServiceClient.createTrainingPipeline(parent, trainingPipeline);
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The resource name of the Location to create the TrainingPipeline in.
Format: |
trainingPipeline | TrainingPipeline Required. The TrainingPipeline to create. |
Returns | |
---|---|
Type | Description |
TrainingPipeline |
createTrainingPipelineCallable()
public final UnaryCallable<CreateTrainingPipelineRequest,TrainingPipeline> createTrainingPipelineCallable()
Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
CreateTrainingPipelineRequest request =
CreateTrainingPipelineRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setTrainingPipeline(TrainingPipeline.newBuilder().build())
.build();
ApiFuture<TrainingPipeline> future =
pipelineServiceClient.createTrainingPipelineCallable().futureCall(request);
// Do something.
TrainingPipeline response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateTrainingPipelineRequest,TrainingPipeline> |
deletePipelineJobAsync(DeletePipelineJobRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deletePipelineJobAsync(DeletePipelineJobRequest request)
Deletes a PipelineJob.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
DeletePipelineJobRequest request =
DeletePipelineJobRequest.newBuilder()
.setName(PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString())
.build();
pipelineServiceClient.deletePipelineJobAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeletePipelineJobRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deletePipelineJobAsync(PipelineJobName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deletePipelineJobAsync(PipelineJobName name)
Deletes a PipelineJob.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
PipelineJobName name = PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]");
pipelineServiceClient.deletePipelineJobAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | PipelineJobName Required. The name of the PipelineJob resource to be deleted. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deletePipelineJobAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deletePipelineJobAsync(String name)
Deletes a PipelineJob.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
String name = PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString();
pipelineServiceClient.deletePipelineJobAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the PipelineJob resource to be deleted. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deletePipelineJobCallable()
public final UnaryCallable<DeletePipelineJobRequest,Operation> deletePipelineJobCallable()
Deletes a PipelineJob.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
DeletePipelineJobRequest request =
DeletePipelineJobRequest.newBuilder()
.setName(PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString())
.build();
ApiFuture<Operation> future =
pipelineServiceClient.deletePipelineJobCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeletePipelineJobRequest,Operation> |
deletePipelineJobOperationCallable()
public final OperationCallable<DeletePipelineJobRequest,Empty,DeleteOperationMetadata> deletePipelineJobOperationCallable()
Deletes a PipelineJob.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
DeletePipelineJobRequest request =
DeletePipelineJobRequest.newBuilder()
.setName(PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString())
.build();
OperationFuture<Empty, DeleteOperationMetadata> future =
pipelineServiceClient.deletePipelineJobOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeletePipelineJobRequest,Empty,DeleteOperationMetadata> |
deleteTrainingPipelineAsync(DeleteTrainingPipelineRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteTrainingPipelineAsync(DeleteTrainingPipelineRequest request)
Deletes a TrainingPipeline.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
DeleteTrainingPipelineRequest request =
DeleteTrainingPipelineRequest.newBuilder()
.setName(
TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
.toString())
.build();
pipelineServiceClient.deleteTrainingPipelineAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteTrainingPipelineRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteTrainingPipelineAsync(TrainingPipelineName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteTrainingPipelineAsync(TrainingPipelineName name)
Deletes a TrainingPipeline.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
TrainingPipelineName name =
TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]");
pipelineServiceClient.deleteTrainingPipelineAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | TrainingPipelineName Required. The name of the TrainingPipeline resource to be deleted. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteTrainingPipelineAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteTrainingPipelineAsync(String name)
Deletes a TrainingPipeline.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
String name =
TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]").toString();
pipelineServiceClient.deleteTrainingPipelineAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the TrainingPipeline resource to be deleted. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteTrainingPipelineCallable()
public final UnaryCallable<DeleteTrainingPipelineRequest,Operation> deleteTrainingPipelineCallable()
Deletes a TrainingPipeline.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
DeleteTrainingPipelineRequest request =
DeleteTrainingPipelineRequest.newBuilder()
.setName(
TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
.toString())
.build();
ApiFuture<Operation> future =
pipelineServiceClient.deleteTrainingPipelineCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteTrainingPipelineRequest,Operation> |
deleteTrainingPipelineOperationCallable()
public final OperationCallable<DeleteTrainingPipelineRequest,Empty,DeleteOperationMetadata> deleteTrainingPipelineOperationCallable()
Deletes a TrainingPipeline.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
DeleteTrainingPipelineRequest request =
DeleteTrainingPipelineRequest.newBuilder()
.setName(
TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
.toString())
.build();
OperationFuture<Empty, DeleteOperationMetadata> future =
pipelineServiceClient.deleteTrainingPipelineOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteTrainingPipelineRequest,Empty,DeleteOperationMetadata> |
getIamPolicy(GetIamPolicyRequest request)
public final Policy getIamPolicy(GetIamPolicyRequest request)
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = pipelineServiceClient.getIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future = pipelineServiceClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)
Gets information about a location.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = pipelineServiceClient.getLocation(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Gets information about a location.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = pipelineServiceClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getPipelineJob(GetPipelineJobRequest request)
public final PipelineJob getPipelineJob(GetPipelineJobRequest request)
Gets a PipelineJob.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
GetPipelineJobRequest request =
GetPipelineJobRequest.newBuilder()
.setName(PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString())
.build();
PipelineJob response = pipelineServiceClient.getPipelineJob(request);
}
Parameter | |
---|---|
Name | Description |
request | GetPipelineJobRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
PipelineJob |
getPipelineJob(PipelineJobName name)
public final PipelineJob getPipelineJob(PipelineJobName name)
Gets a PipelineJob.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
PipelineJobName name = PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]");
PipelineJob response = pipelineServiceClient.getPipelineJob(name);
}
Parameter | |
---|---|
Name | Description |
name | PipelineJobName Required. The name of the PipelineJob resource. Format:
|
Returns | |
---|---|
Type | Description |
PipelineJob |
getPipelineJob(String name)
public final PipelineJob getPipelineJob(String name)
Gets a PipelineJob.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
String name = PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString();
PipelineJob response = pipelineServiceClient.getPipelineJob(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the PipelineJob resource. Format:
|
Returns | |
---|---|
Type | Description |
PipelineJob |
getPipelineJobCallable()
public final UnaryCallable<GetPipelineJobRequest,PipelineJob> getPipelineJobCallable()
Gets a PipelineJob.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
GetPipelineJobRequest request =
GetPipelineJobRequest.newBuilder()
.setName(PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString())
.build();
ApiFuture<PipelineJob> future =
pipelineServiceClient.getPipelineJobCallable().futureCall(request);
// Do something.
PipelineJob response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetPipelineJobRequest,PipelineJob> |
getSettings()
public final PipelineServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
PipelineServiceSettings |
getStub()
public PipelineServiceStub getStub()
Returns | |
---|---|
Type | Description |
PipelineServiceStub |
getTrainingPipeline(GetTrainingPipelineRequest request)
public final TrainingPipeline getTrainingPipeline(GetTrainingPipelineRequest request)
Gets a TrainingPipeline.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
GetTrainingPipelineRequest request =
GetTrainingPipelineRequest.newBuilder()
.setName(
TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
.toString())
.build();
TrainingPipeline response = pipelineServiceClient.getTrainingPipeline(request);
}
Parameter | |
---|---|
Name | Description |
request | GetTrainingPipelineRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
TrainingPipeline |
getTrainingPipeline(TrainingPipelineName name)
public final TrainingPipeline getTrainingPipeline(TrainingPipelineName name)
Gets a TrainingPipeline.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
TrainingPipelineName name =
TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]");
TrainingPipeline response = pipelineServiceClient.getTrainingPipeline(name);
}
Parameter | |
---|---|
Name | Description |
name | TrainingPipelineName Required. The name of the TrainingPipeline resource. Format:
|
Returns | |
---|---|
Type | Description |
TrainingPipeline |
getTrainingPipeline(String name)
public final TrainingPipeline getTrainingPipeline(String name)
Gets a TrainingPipeline.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
String name =
TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]").toString();
TrainingPipeline response = pipelineServiceClient.getTrainingPipeline(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the TrainingPipeline resource. Format:
|
Returns | |
---|---|
Type | Description |
TrainingPipeline |
getTrainingPipelineCallable()
public final UnaryCallable<GetTrainingPipelineRequest,TrainingPipeline> getTrainingPipelineCallable()
Gets a TrainingPipeline.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
GetTrainingPipelineRequest request =
GetTrainingPipelineRequest.newBuilder()
.setName(
TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
.toString())
.build();
ApiFuture<TrainingPipeline> future =
pipelineServiceClient.getTrainingPipelineCallable().futureCall(request);
// Do something.
TrainingPipeline response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetTrainingPipelineRequest,TrainingPipeline> |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listLocations(ListLocationsRequest request)
public final PipelineServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
Lists information about the supported locations for this service.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : pipelineServiceClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
PipelineServiceClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response =
pipelineServiceClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,PipelineServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Lists information about the supported locations for this service.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
pipelineServiceClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
listPipelineJobs(ListPipelineJobsRequest request)
public final PipelineServiceClient.ListPipelineJobsPagedResponse listPipelineJobs(ListPipelineJobsRequest request)
Lists PipelineJobs in a Location.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
ListPipelineJobsRequest request =
ListPipelineJobsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setReadMask(FieldMask.newBuilder().build())
.build();
for (PipelineJob element : pipelineServiceClient.listPipelineJobs(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListPipelineJobsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
PipelineServiceClient.ListPipelineJobsPagedResponse |
listPipelineJobs(LocationName parent)
public final PipelineServiceClient.ListPipelineJobsPagedResponse listPipelineJobs(LocationName parent)
Lists PipelineJobs in a Location.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (PipelineJob element : pipelineServiceClient.listPipelineJobs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to list the PipelineJobs from.
Format: |
Returns | |
---|---|
Type | Description |
PipelineServiceClient.ListPipelineJobsPagedResponse |
listPipelineJobs(String parent)
public final PipelineServiceClient.ListPipelineJobsPagedResponse listPipelineJobs(String parent)
Lists PipelineJobs in a Location.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (PipelineJob element : pipelineServiceClient.listPipelineJobs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The resource name of the Location to list the PipelineJobs from.
Format: |
Returns | |
---|---|
Type | Description |
PipelineServiceClient.ListPipelineJobsPagedResponse |
listPipelineJobsCallable()
public final UnaryCallable<ListPipelineJobsRequest,ListPipelineJobsResponse> listPipelineJobsCallable()
Lists PipelineJobs in a Location.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
ListPipelineJobsRequest request =
ListPipelineJobsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setReadMask(FieldMask.newBuilder().build())
.build();
while (true) {
ListPipelineJobsResponse response =
pipelineServiceClient.listPipelineJobsCallable().call(request);
for (PipelineJob element : response.getPipelineJobsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListPipelineJobsRequest,ListPipelineJobsResponse> |
listPipelineJobsPagedCallable()
public final UnaryCallable<ListPipelineJobsRequest,PipelineServiceClient.ListPipelineJobsPagedResponse> listPipelineJobsPagedCallable()
Lists PipelineJobs in a Location.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
ListPipelineJobsRequest request =
ListPipelineJobsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setReadMask(FieldMask.newBuilder().build())
.build();
ApiFuture<PipelineJob> future =
pipelineServiceClient.listPipelineJobsPagedCallable().futureCall(request);
// Do something.
for (PipelineJob element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListPipelineJobsRequest,ListPipelineJobsPagedResponse> |
listTrainingPipelines(ListTrainingPipelinesRequest request)
public final PipelineServiceClient.ListTrainingPipelinesPagedResponse listTrainingPipelines(ListTrainingPipelinesRequest request)
Lists TrainingPipelines in a Location.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
ListTrainingPipelinesRequest request =
ListTrainingPipelinesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.build();
for (TrainingPipeline element :
pipelineServiceClient.listTrainingPipelines(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListTrainingPipelinesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
PipelineServiceClient.ListTrainingPipelinesPagedResponse |
listTrainingPipelines(LocationName parent)
public final PipelineServiceClient.ListTrainingPipelinesPagedResponse listTrainingPipelines(LocationName parent)
Lists TrainingPipelines in a Location.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (TrainingPipeline element :
pipelineServiceClient.listTrainingPipelines(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to list the TrainingPipelines from.
Format: |
Returns | |
---|---|
Type | Description |
PipelineServiceClient.ListTrainingPipelinesPagedResponse |
listTrainingPipelines(String parent)
public final PipelineServiceClient.ListTrainingPipelinesPagedResponse listTrainingPipelines(String parent)
Lists TrainingPipelines in a Location.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (TrainingPipeline element :
pipelineServiceClient.listTrainingPipelines(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The resource name of the Location to list the TrainingPipelines from.
Format: |
Returns | |
---|---|
Type | Description |
PipelineServiceClient.ListTrainingPipelinesPagedResponse |
listTrainingPipelinesCallable()
public final UnaryCallable<ListTrainingPipelinesRequest,ListTrainingPipelinesResponse> listTrainingPipelinesCallable()
Lists TrainingPipelines in a Location.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
ListTrainingPipelinesRequest request =
ListTrainingPipelinesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.build();
while (true) {
ListTrainingPipelinesResponse response =
pipelineServiceClient.listTrainingPipelinesCallable().call(request);
for (TrainingPipeline element : response.getTrainingPipelinesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListTrainingPipelinesRequest,ListTrainingPipelinesResponse> |
listTrainingPipelinesPagedCallable()
public final UnaryCallable<ListTrainingPipelinesRequest,PipelineServiceClient.ListTrainingPipelinesPagedResponse> listTrainingPipelinesPagedCallable()
Lists TrainingPipelines in a Location.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
ListTrainingPipelinesRequest request =
ListTrainingPipelinesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.build();
ApiFuture<TrainingPipeline> future =
pipelineServiceClient.listTrainingPipelinesPagedCallable().futureCall(request);
// Do something.
for (TrainingPipeline element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListTrainingPipelinesRequest,ListTrainingPipelinesPagedResponse> |
setIamPolicy(SetIamPolicyRequest request)
public final Policy setIamPolicy(SetIamPolicyRequest request)
Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = pipelineServiceClient.setIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future = pipelineServiceClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
testIamPermissions(TestIamPermissionsRequest request)
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)
Returns permissions that a caller has on the specified resource. If theresource does not exist,
this will return an empty set ofpermissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response = pipelineServiceClient.testIamPermissions(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
testIamPermissionsCallable()
public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource. If theresource does not exist,
this will return an empty set ofpermissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
Sample code:
// 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 (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
pipelineServiceClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |