ProjectServiceClient (Google Discovery Engine API 0.52.0 API)

java.lang.Object
- com.google.cloud.discoveryengine.v1.ProjectServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class ProjectServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for operations on the [Project][google.cloud.discoveryengine.v1.Project].

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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   Project response = projectServiceClient.provisionProjectAsync(name).get();
 }

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

Methods
Method	Description	Method Variants
ProvisionProject	Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.	Request object method variants only take one parameter, a request object, which must be constructed before the call. provisionProjectAsync(ProvisionProjectRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. provisionProjectAsync(ProjectName name) provisionProjectAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. provisionProjectOperationCallable() provisionProjectCallable()

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 ProjectServiceSettings 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
 ProjectServiceSettings projectServiceSettings =
     ProjectServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProjectServiceClient projectServiceClient = ProjectServiceClient.create(projectServiceSettings);

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
 ProjectServiceSettings projectServiceSettings =
     ProjectServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ProjectServiceClient projectServiceClient = ProjectServiceClient.create(projectServiceSettings);

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
 ProjectServiceSettings projectServiceSettings =
     ProjectServiceSettings.newHttpJsonBuilder().build();
 ProjectServiceClient projectServiceClient = ProjectServiceClient.create(projectServiceSettings);

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ProjectServiceClient(ProjectServiceSettings settings)` Constructs an instance of ProjectServiceClient, using the given settings.
`protected`	`ProjectServiceClient(ProjectServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ProjectServiceClient`	`create()` Constructs an instance of ProjectServiceClient with default settings.
`static ProjectServiceClient`	`create(ProjectServiceSettings settings)` Constructs an instance of ProjectServiceClient, using the given settings.
`static ProjectServiceClient`	`create(ProjectServiceStub stub)` Constructs an instance of ProjectServiceClient, using the given stub for making calls.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`ProjectServiceSettings`	`getSettings()`
`ProjectServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`com.google.api.gax.longrunning.OperationFuture<Project,ProvisionProjectMetadata>`	`provisionProjectAsync(ProjectName name)` Provisions the project resource.
`com.google.api.gax.longrunning.OperationFuture<Project,ProvisionProjectMetadata>`	`provisionProjectAsync(ProvisionProjectRequest request)` Provisions the project resource.
`com.google.api.gax.longrunning.OperationFuture<Project,ProvisionProjectMetadata>`	`provisionProjectAsync(String name)` Provisions the project resource.
`com.google.api.gax.rpc.UnaryCallable<ProvisionProjectRequest,com.google.longrunning.Operation>`	`provisionProjectCallable()` Provisions the project resource.
`com.google.api.gax.rpc.OperationCallable<ProvisionProjectRequest,Project,ProvisionProjectMetadata>`	`provisionProjectOperationCallable()` Provisions the project resource.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ProjectServiceClient
```
protected ProjectServiceClient(ProjectServiceSettings settings)
                        throws IOException
```
  Constructs an instance of ProjectServiceClient, 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.
  
  Throws:
  
  IOException
- ProjectServiceClient
```
protected ProjectServiceClient(ProjectServiceStub stub)
```

Method Detail

create

public static final ProjectServiceClient create()
                                         throws IOException

Constructs an instance of ProjectServiceClient with default settings.

Throws:: IOException

create
```
public static final ProjectServiceClient create(ProjectServiceSettings settings)
                                         throws IOException
```
Constructs an instance of ProjectServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final ProjectServiceClient create(ProjectServiceStub stub)
```
Constructs an instance of ProjectServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ProjectServiceSettings).

getSettings

public final ProjectServiceSettings getSettings()

getStub
```
public ProjectServiceStub getStub()
```

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient
```
@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

provisionProjectAsync

public final com.google.api.gax.longrunning.OperationFuture<Project,ProvisionProjectMetadata> provisionProjectAsync(ProjectName name)

Provisions the project resource. During the process, related systems will get prepared and initialized.

Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.

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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   Project response = projectServiceClient.provisionProjectAsync(name).get();
 }

Parameters:: name - Required. Full resource name of a [Project][google.cloud.discoveryengine.v1.Project], such as `projects/{project_id_or_number}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

provisionProjectAsync

public final com.google.api.gax.longrunning.OperationFuture<Project,ProvisionProjectMetadata> provisionProjectAsync(String name)

Provisions the project resource. During the process, related systems will get prepared and initialized.

Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.

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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   String name = ProjectName.of("[PROJECT]").toString();
   Project response = projectServiceClient.provisionProjectAsync(name).get();
 }

Parameters:: name - Required. Full resource name of a [Project][google.cloud.discoveryengine.v1.Project], such as `projects/{project_id_or_number}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

provisionProjectAsync

public final com.google.api.gax.longrunning.OperationFuture<Project,ProvisionProjectMetadata> provisionProjectAsync(ProvisionProjectRequest request)

Provisions the project resource. During the process, related systems will get prepared and initialized.

Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.

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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   ProvisionProjectRequest request =
       ProvisionProjectRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .setAcceptDataUseTerms(true)
           .setDataUseTermsVersion("dataUseTermsVersion-1913570450")
           .build();
   Project response = projectServiceClient.provisionProjectAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

provisionProjectOperationCallable

public final com.google.api.gax.rpc.OperationCallable<ProvisionProjectRequest,Project,ProvisionProjectMetadata> provisionProjectOperationCallable()

Provisions the project resource. During the process, related systems will get prepared and initialized.

Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.

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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   ProvisionProjectRequest request =
       ProvisionProjectRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .setAcceptDataUseTerms(true)
           .setDataUseTermsVersion("dataUseTermsVersion-1913570450")
           .build();
   OperationFuture<Project, ProvisionProjectMetadata> future =
       projectServiceClient.provisionProjectOperationCallable().futureCall(request);
   // Do something.
   Project response = future.get();
 }

provisionProjectCallable

public final com.google.api.gax.rpc.UnaryCallable<ProvisionProjectRequest,com.google.longrunning.Operation> provisionProjectCallable()

Provisions the project resource. During the process, related systems will get prepared and initialized.

Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.

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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
   ProvisionProjectRequest request =
       ProvisionProjectRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .setAcceptDataUseTerms(true)
           .setDataUseTermsVersion("dataUseTermsVersion-1913570450")
           .build();
   ApiFuture<Operation> future =
       projectServiceClient.provisionProjectCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class ProjectServiceClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProjectServiceClient

ProjectServiceClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

getHttpJsonOperationsClient

provisionProjectAsync

provisionProjectAsync

provisionProjectAsync

provisionProjectOperationCallable

provisionProjectCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination