SchemaServiceClient (Google Discovery Engine API 0.45.0 API)

java.lang.Object
- com.google.cloud.discoveryengine.v1alpha.SchemaServiceClient

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

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

Service Description: Service for managing [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.

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 (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name =
       SchemaName.ofProjectLocationDataStoreSchemaName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]");
   Schema response = schemaServiceClient.getSchema(name);
 }

Note: close() needs to be called on the SchemaServiceClient 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
GetSchema	Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema].	Request object method variants only take one parameter, a request object, which must be constructed before the call. getSchema(GetSchemaRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getSchema(SchemaName name) getSchema(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. getSchemaCallable()
ListSchemas	Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listSchemas(ListSchemasRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listSchemas(DataStoreName parent) listSchemas(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listSchemasPagedCallable() listSchemasCallable()
CreateSchema	Creates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].	Request object method variants only take one parameter, a request object, which must be constructed before the call. createSchemaAsync(CreateSchemaRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createSchemaAsync(DataStoreName parent, Schema schema, String schemaId) createSchemaAsync(String parent, Schema schema, String schemaId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createSchemaOperationCallable() createSchemaCallable()
UpdateSchema	Updates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateSchemaAsync(UpdateSchemaRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateSchemaOperationCallable() updateSchemaCallable()
DeleteSchema	Deletes a [Schema][google.cloud.discoveryengine.v1alpha.Schema].	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteSchemaAsync(DeleteSchemaRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteSchemaAsync(SchemaName name) deleteSchemaAsync(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. deleteSchemaOperationCallable() deleteSchemaCallable()

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 SchemaServiceSettings 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
 SchemaServiceSettings schemaServiceSettings =
     SchemaServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SchemaServiceClient schemaServiceClient = SchemaServiceClient.create(schemaServiceSettings);

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
 SchemaServiceSettings schemaServiceSettings =
     SchemaServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SchemaServiceClient schemaServiceClient = SchemaServiceClient.create(schemaServiceSettings);

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
 SchemaServiceSettings schemaServiceSettings =
     SchemaServiceSettings.newHttpJsonBuilder().build();
 SchemaServiceClient schemaServiceClient = SchemaServiceClient.create(schemaServiceSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SchemaServiceClient.ListSchemasFixedSizeCollection`
`static class`	`SchemaServiceClient.ListSchemasPage`
`static class`	`SchemaServiceClient.ListSchemasPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SchemaServiceClient(SchemaServiceSettings settings)` Constructs an instance of SchemaServiceClient, using the given settings.
`protected`	`SchemaServiceClient(SchemaServiceStub 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 SchemaServiceClient`	`create()` Constructs an instance of SchemaServiceClient with default settings.
`static SchemaServiceClient`	`create(SchemaServiceSettings settings)` Constructs an instance of SchemaServiceClient, using the given settings.
`static SchemaServiceClient`	`create(SchemaServiceStub stub)` Constructs an instance of SchemaServiceClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<Schema,CreateSchemaMetadata>`	`createSchemaAsync(CreateSchemaRequest request)` Creates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`com.google.api.gax.longrunning.OperationFuture<Schema,CreateSchemaMetadata>`	`createSchemaAsync(DataStoreName parent, Schema schema, String schemaId)` Creates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`com.google.api.gax.longrunning.OperationFuture<Schema,CreateSchemaMetadata>`	`createSchemaAsync(String parent, Schema schema, String schemaId)` Creates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`com.google.api.gax.rpc.UnaryCallable<CreateSchemaRequest,com.google.longrunning.Operation>`	`createSchemaCallable()` Creates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`com.google.api.gax.rpc.OperationCallable<CreateSchemaRequest,Schema,CreateSchemaMetadata>`	`createSchemaOperationCallable()` Creates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteSchemaMetadata>`	`deleteSchemaAsync(DeleteSchemaRequest request)` Deletes a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteSchemaMetadata>`	`deleteSchemaAsync(SchemaName name)` Deletes a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteSchemaMetadata>`	`deleteSchemaAsync(String name)` Deletes a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`com.google.api.gax.rpc.UnaryCallable<DeleteSchemaRequest,com.google.longrunning.Operation>`	`deleteSchemaCallable()` Deletes a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`com.google.api.gax.rpc.OperationCallable<DeleteSchemaRequest,com.google.protobuf.Empty,DeleteSchemaMetadata>`	`deleteSchemaOperationCallable()` Deletes a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`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.
`Schema`	`getSchema(GetSchemaRequest request)` Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`Schema`	`getSchema(SchemaName name)` Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`Schema`	`getSchema(String name)` Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`com.google.api.gax.rpc.UnaryCallable<GetSchemaRequest,Schema>`	`getSchemaCallable()` Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`SchemaServiceSettings`	`getSettings()`
`SchemaServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`SchemaServiceClient.ListSchemasPagedResponse`	`listSchemas(DataStoreName parent)` Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.
`SchemaServiceClient.ListSchemasPagedResponse`	`listSchemas(ListSchemasRequest request)` Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.
`SchemaServiceClient.ListSchemasPagedResponse`	`listSchemas(String parent)` Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.
`com.google.api.gax.rpc.UnaryCallable<ListSchemasRequest,ListSchemasResponse>`	`listSchemasCallable()` Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.
`com.google.api.gax.rpc.UnaryCallable<ListSchemasRequest,SchemaServiceClient.ListSchemasPagedResponse>`	`listSchemasPagedCallable()` Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.longrunning.OperationFuture<Schema,UpdateSchemaMetadata>`	`updateSchemaAsync(UpdateSchemaRequest request)` Updates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`com.google.api.gax.rpc.UnaryCallable<UpdateSchemaRequest,com.google.longrunning.Operation>`	`updateSchemaCallable()` Updates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
`com.google.api.gax.rpc.OperationCallable<UpdateSchemaRequest,Schema,UpdateSchemaMetadata>`	`updateSchemaOperationCallable()` Updates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].

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

Constructor Detail
- SchemaServiceClient
```
protected SchemaServiceClient(SchemaServiceSettings settings)
                       throws IOException
```
  Constructs an instance of SchemaServiceClient, 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
- SchemaServiceClient
```
protected SchemaServiceClient(SchemaServiceStub stub)
```

Method Detail

create

public static final SchemaServiceClient create()
                                        throws IOException

Constructs an instance of SchemaServiceClient with default settings.

Throws:: IOException

create
```
public static final SchemaServiceClient create(SchemaServiceSettings settings)
                                        throws IOException
```
Constructs an instance of SchemaServiceClient, 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 SchemaServiceClient create(SchemaServiceStub stub)
```
Constructs an instance of SchemaServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SchemaServiceSettings).

getSettings

public final SchemaServiceSettings getSettings()

getStub
```
public SchemaServiceStub 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.

getSchema

public final Schema getSchema(SchemaName name)

Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema].

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 (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name =
       SchemaName.ofProjectLocationDataStoreSchemaName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]");
   Schema response = schemaServiceClient.getSchema(name);
 }

Parameters:: name - Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getSchema

public final Schema getSchema(String name)

Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema].

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 (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   String name =
       SchemaName.ofProjectLocationDataStoreSchemaName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]")
           .toString();
   Schema response = schemaServiceClient.getSchema(name);
 }

Parameters:: name - Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getSchema

public final Schema getSchema(GetSchemaRequest request)

Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema].

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 (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   GetSchemaRequest request =
       GetSchemaRequest.newBuilder()
           .setName(
               SchemaName.ofProjectLocationDataStoreSchemaName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]")
                   .toString())
           .build();
   Schema response = schemaServiceClient.getSchema(request);
 }

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

getSchemaCallable

public final com.google.api.gax.rpc.UnaryCallable<GetSchemaRequest,Schema> getSchemaCallable()

Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema].

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 (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   GetSchemaRequest request =
       GetSchemaRequest.newBuilder()
           .setName(
               SchemaName.ofProjectLocationDataStoreSchemaName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]")
                   .toString())
           .build();
   ApiFuture<Schema> future = schemaServiceClient.getSchemaCallable().futureCall(request);
   // Do something.
   Schema response = future.get();
 }

listSchemas

public final SchemaServiceClient.ListSchemasPagedResponse listSchemas(DataStoreName parent)

Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.

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 (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   DataStoreName parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   for (Schema element : schemaServiceClient.listSchemas(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listSchemas

public final SchemaServiceClient.ListSchemasPagedResponse listSchemas(String parent)

Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.

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 (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   String parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]")
           .toString();
   for (Schema element : schemaServiceClient.listSchemas(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listSchemas

public final SchemaServiceClient.ListSchemasPagedResponse listSchemas(ListSchemasRequest request)

Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.

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 (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ListSchemasRequest request =
       ListSchemasRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Schema element : schemaServiceClient.listSchemas(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

listSchemasPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListSchemasRequest,SchemaServiceClient.ListSchemasPagedResponse> listSchemasPagedCallable()

Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.

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 (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ListSchemasRequest request =
       ListSchemasRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Schema> future = schemaServiceClient.listSchemasPagedCallable().futureCall(request);
   // Do something.
   for (Schema element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listSchemasCallable

public final com.google.api.gax.rpc.UnaryCallable<ListSchemasRequest,ListSchemasResponse> listSchemasCallable()

Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.

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 (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ListSchemasRequest request =
       ListSchemasRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSchemasResponse response = schemaServiceClient.listSchemasCallable().call(request);
     for (Schema element : response.getSchemasList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }