Class SchemaServiceClient (0.49.0)

Version 0.49.0

• 0.50.0 (latest)
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

GitHub Repository

Product Reference

Service Description: Service for managing Schemas.

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

Inheritance

java.lang.Object > SchemaServiceClient

Static Methods

create()

public static final SchemaServiceClient create()

Constructs an instance of SchemaServiceClient with default settings.

Returns
Type	Description
SchemaServiceClient

Exceptions
Type	Description
IOException

create(SchemaServiceSettings settings)

public static final SchemaServiceClient create(SchemaServiceSettings settings)

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.

Parameter
Name	Description
settings	SchemaServiceSettings

Returns
Type	Description
SchemaServiceClient

Exceptions
Type	Description
IOException

create(SchemaServiceStub stub)

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

Parameter
Name	Description
stub	SchemaServiceStub

Returns
Type	Description
SchemaServiceClient

Constructors

SchemaServiceClient(SchemaServiceSettings settings)

protected SchemaServiceClient(SchemaServiceSettings settings)

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.

Parameter
Name	Description
settings	SchemaServiceSettings

SchemaServiceClient(SchemaServiceStub stub)

protected SchemaServiceClient(SchemaServiceStub stub)

Parameter
Name	Description
stub	SchemaServiceStub

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

close()

public final void close()

createSchemaAsync(CreateSchemaRequest request)

public final OperationFuture<Schema,CreateSchemaMetadata> createSchemaAsync(CreateSchemaRequest request)

Creates a 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()) {
   CreateSchemaRequest request =
       CreateSchemaRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setSchema(Schema.newBuilder().build())
           .setSchemaId("schemaId-697673060")
           .build();
   Schema response = schemaServiceClient.createSchemaAsync(request).get();
 }
 

Parameter
Name	Description
request	CreateSchemaRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Schema,CreateSchemaMetadata>

createSchemaAsync(DataStoreName parent, Schema schema, String schemaId)

public final OperationFuture<Schema,CreateSchemaMetadata> createSchemaAsync(DataStoreName parent, Schema schema, String schemaId)

Creates a 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()) {
   DataStoreName parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   Schema schema = Schema.newBuilder().build();
   String schemaId = "schemaId-697673060";
   Schema response = schemaServiceClient.createSchemaAsync(parent, schema, schemaId).get();
 }
 

Parameters
Name	Description
parent	DataStoreName Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.
schema	Schema Required. The Schema to create.
schemaId	String Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to RFC-1034 standard with a length limit of 63 characters.

Returns
Type	Description
OperationFuture<Schema,CreateSchemaMetadata>

createSchemaAsync(String parent, Schema schema, String schemaId)

public final OperationFuture<Schema,CreateSchemaMetadata> createSchemaAsync(String parent, Schema schema, String schemaId)

Creates a 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 parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]")
           .toString();
   Schema schema = Schema.newBuilder().build();
   String schemaId = "schemaId-697673060";
   Schema response = schemaServiceClient.createSchemaAsync(parent, schema, schemaId).get();
 }
 

Parameters
Name	Description
parent	String Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.
schema	Schema Required. The Schema to create.
schemaId	String Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to RFC-1034 standard with a length limit of 63 characters.

Returns
Type	Description
OperationFuture<Schema,CreateSchemaMetadata>

createSchemaCallable()

public final UnaryCallable<CreateSchemaRequest,Operation> createSchemaCallable()

Creates a 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()) {
   CreateSchemaRequest request =
       CreateSchemaRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setSchema(Schema.newBuilder().build())
           .setSchemaId("schemaId-697673060")
           .build();
   ApiFuture<Operation> future = schemaServiceClient.createSchemaCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateSchemaRequest,Operation>

createSchemaOperationCallable()

public final OperationCallable<CreateSchemaRequest,Schema,CreateSchemaMetadata> createSchemaOperationCallable()

Creates a 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()) {
   CreateSchemaRequest request =
       CreateSchemaRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setSchema(Schema.newBuilder().build())
           .setSchemaId("schemaId-697673060")
           .build();
   OperationFuture<Schema, CreateSchemaMetadata> future =
       schemaServiceClient.createSchemaOperationCallable().futureCall(request);
   // Do something.
   Schema response = future.get();
 }
 

Returns
Type	Description
OperationCallable<CreateSchemaRequest,Schema,CreateSchemaMetadata>

deleteSchemaAsync(DeleteSchemaRequest request)

public final OperationFuture<Empty,DeleteSchemaMetadata> deleteSchemaAsync(DeleteSchemaRequest request)

Deletes a 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()) {
   DeleteSchemaRequest request =
       DeleteSchemaRequest.newBuilder()
           .setName(
               SchemaName.ofProjectLocationDataStoreSchemaName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]")
                   .toString())
           .build();
   schemaServiceClient.deleteSchemaAsync(request).get();
 }
 

Parameter
Name	Description
request	DeleteSchemaRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Empty,DeleteSchemaMetadata>

deleteSchemaAsync(SchemaName name)

public final OperationFuture<Empty,DeleteSchemaMetadata> deleteSchemaAsync(SchemaName name)

Deletes a 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]");
   schemaServiceClient.deleteSchemaAsync(name).get();
 }
 

Parameter
Name	Description
name	SchemaName Required. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

Returns
Type	Description
OperationFuture<Empty,DeleteSchemaMetadata>

deleteSchemaAsync(String name)

public final OperationFuture<Empty,DeleteSchemaMetadata> deleteSchemaAsync(String name)

Deletes a 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();
   schemaServiceClient.deleteSchemaAsync(name).get();
 }
 

Parameter
Name	Description
name	String Required. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

Returns
Type	Description
OperationFuture<Empty,DeleteSchemaMetadata>

deleteSchemaCallable()

public final UnaryCallable<DeleteSchemaRequest,Operation> deleteSchemaCallable()

Deletes a 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()) {
   DeleteSchemaRequest request =
       DeleteSchemaRequest.newBuilder()
           .setName(
               SchemaName.ofProjectLocationDataStoreSchemaName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]")
                   .toString())
           .build();
   ApiFuture<Operation> future = schemaServiceClient.deleteSchemaCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteSchemaRequest,Operation>

deleteSchemaOperationCallable()

public final OperationCallable<DeleteSchemaRequest,Empty,DeleteSchemaMetadata> deleteSchemaOperationCallable()

Deletes a 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()) {
   DeleteSchemaRequest request =
       DeleteSchemaRequest.newBuilder()
           .setName(
               SchemaName.ofProjectLocationDataStoreSchemaName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteSchemaMetadata> future =
       schemaServiceClient.deleteSchemaOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
OperationCallable<DeleteSchemaRequest,Empty,DeleteSchemaMetadata>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

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

getSchema(GetSchemaRequest request)

public final Schema getSchema(GetSchemaRequest request)

Gets a 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);
 }
 

Parameter
Name	Description
request	GetSchemaRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Schema

getSchema(SchemaName name)

public final Schema getSchema(SchemaName name)

Gets a 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);
 }
 

Parameter
Name	Description
name	SchemaName Required. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

Returns
Type	Description
Schema

getSchema(String name)

public final Schema getSchema(String name)

Gets a 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);
 }
 

Parameter
Name	Description
name	String Required. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

Returns
Type	Description
Schema

getSchemaCallable()

public final UnaryCallable<GetSchemaRequest,Schema> getSchemaCallable()

Gets a 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();
 }
 

Returns
Type	Description
UnaryCallable<GetSchemaRequest,Schema>

getSettings()

public final SchemaServiceSettings getSettings()

Returns
Type	Description
SchemaServiceSettings

getStub()

public SchemaServiceStub getStub()

Returns
Type	Description
SchemaServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listSchemas(DataStoreName parent)

public final SchemaServiceClient.ListSchemasPagedResponse listSchemas(DataStoreName parent)

Gets a list of Schemas.

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

Parameter
Name	Description
parent	DataStoreName Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

Returns
Type	Description
SchemaServiceClient.ListSchemasPagedResponse

listSchemas(ListSchemasRequest request)

public final SchemaServiceClient.ListSchemasPagedResponse listSchemas(ListSchemasRequest request)

Gets a list of Schemas.

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

Parameter
Name	Description
request	ListSchemasRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
SchemaServiceClient.ListSchemasPagedResponse

listSchemas(String parent)

public final SchemaServiceClient.ListSchemasPagedResponse listSchemas(String parent)

Gets a list of Schemas.

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

Parameter
Name	Description
parent	String Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

Returns
Type	Description
SchemaServiceClient.ListSchemasPagedResponse

listSchemasCallable()

public final UnaryCallable<ListSchemasRequest,ListSchemasResponse> listSchemasCallable()

Gets a list of Schemas.

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

Returns
Type	Description
UnaryCallable<ListSchemasRequest,ListSchemasResponse>

listSchemasPagedCallable()

public final UnaryCallable<ListSchemasRequest,SchemaServiceClient.ListSchemasPagedResponse> listSchemasPagedCallable()

Gets a list of Schemas.

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

Returns
Type	Description
UnaryCallable<ListSchemasRequest,ListSchemasPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateSchemaAsync(UpdateSchemaRequest request)

public final OperationFuture<Schema,UpdateSchemaMetadata> updateSchemaAsync(UpdateSchemaRequest request)

Updates a 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()) {
   UpdateSchemaRequest request =
       UpdateSchemaRequest.newBuilder()
           .setSchema(Schema.newBuilder().build())
           .setAllowMissing(true)
           .build();
   Schema response = schemaServiceClient.updateSchemaAsync(request).get();
 }
 

Parameter
Name	Description
request	UpdateSchemaRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Schema,UpdateSchemaMetadata>

updateSchemaCallable()

public final UnaryCallable<UpdateSchemaRequest,Operation> updateSchemaCallable()

Updates a 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()) {
   UpdateSchemaRequest request =
       UpdateSchemaRequest.newBuilder()
           .setSchema(Schema.newBuilder().build())
           .setAllowMissing(true)
           .build();
   ApiFuture<Operation> future = schemaServiceClient.updateSchemaCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateSchemaRequest,Operation>

updateSchemaOperationCallable()

public final OperationCallable<UpdateSchemaRequest,Schema,UpdateSchemaMetadata> updateSchemaOperationCallable()

Updates a 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()) {
   UpdateSchemaRequest request =
       UpdateSchemaRequest.newBuilder()
           .setSchema(Schema.newBuilder().build())
           .setAllowMissing(true)
           .build();
   OperationFuture<Schema, UpdateSchemaMetadata> future =
       schemaServiceClient.updateSchemaOperationCallable().futureCall(request);
   // Do something.
   Schema response = future.get();
 }
 

Returns
Type	Description
OperationCallable<UpdateSchemaRequest,Schema,UpdateSchemaMetadata>