com.google.cloud.pubsub.v1

Class SchemaServiceClient

java.lang.Object

com.google.cloud.pubsub.v1.SchemaServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

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

Service Description: Service for doing schema-related operations.

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:

 
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Schema schema = Schema.newBuilder().build();
   String schemaId = "";
   Schema response = schemaServiceClient.createSchema(parent, schema, schemaId);
 }
 
 

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

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of SchemaServiceSettings to create(). For example:

To customize credentials:

 
 SchemaServiceSettings schemaServiceSettings =
     SchemaServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SchemaServiceClient schemaServiceClient =
     SchemaServiceClient.create(schemaServiceSettings);
 
 

To customize the endpoint:

 
 SchemaServiceSettings schemaServiceSettings =
     SchemaServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SchemaServiceClient schemaServiceClient =
     SchemaServiceClient.create(schemaServiceSettings);
 
 

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

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.
Schema	createSchema(CreateSchemaRequest request) Creates a schema.
Schema	createSchema(ProjectName parent, Schema schema, String schemaId) Creates a schema.
Schema	createSchema(String parent, Schema schema, String schemaId) Creates a schema.
com.google.api.gax.rpc.UnaryCallable<CreateSchemaRequest,Schema>	createSchemaCallable() Creates a schema.
void	deleteSchema(DeleteSchemaRequest request) Deletes a schema.
void	deleteSchema(SchemaName name) Deletes a schema.
void	deleteSchema(String name) Deletes a schema.
com.google.api.gax.rpc.UnaryCallable<DeleteSchemaRequest,com.google.protobuf.Empty>	deleteSchemaCallable() Deletes a schema.
Schema	getSchema(GetSchemaRequest request) Gets a schema.
Schema	getSchema(SchemaName name) Gets a schema.
Schema	getSchema(String name) Gets a schema.
com.google.api.gax.rpc.UnaryCallable<GetSchemaRequest,Schema>	getSchemaCallable() Gets a schema.
SchemaServiceSettings	getSettings()
SchemaServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
SchemaServiceClient.ListSchemasPagedResponse	listSchemas(ListSchemasRequest request) Lists schemas in a project.
SchemaServiceClient.ListSchemasPagedResponse	listSchemas(ProjectName parent) Lists schemas in a project.
SchemaServiceClient.ListSchemasPagedResponse	listSchemas(String parent) Lists schemas in a project.
com.google.api.gax.rpc.UnaryCallable<ListSchemasRequest,ListSchemasResponse>	listSchemasCallable() Lists schemas in a project.
com.google.api.gax.rpc.UnaryCallable<ListSchemasRequest,SchemaServiceClient.ListSchemasPagedResponse>	listSchemasPagedCallable() Lists schemas in a project.
void	shutdown()
void	shutdownNow()
ValidateMessageResponse	validateMessage(ValidateMessageRequest request) Validates a message against a schema.
com.google.api.gax.rpc.UnaryCallable<ValidateMessageRequest,ValidateMessageResponse>	validateMessageCallable() Validates a message against a schema.
ValidateSchemaResponse	validateSchema(ProjectName parent, Schema schema) Validates a schema.
ValidateSchemaResponse	validateSchema(String parent, Schema schema) Validates a schema.
ValidateSchemaResponse	validateSchema(ValidateSchemaRequest request) Validates a schema.
com.google.api.gax.rpc.UnaryCallable<ValidateSchemaRequest,ValidateSchemaResponse>	validateSchemaCallable() Validates a 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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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 to use SchemaServiceSettings}.

getSettings

public final SchemaServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public SchemaServiceStub getStub()

createSchema

public final Schema createSchema(ProjectName parent,
                                 Schema schema,
                                 String schemaId)

Creates a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Schema schema = Schema.newBuilder().build();
   String schemaId = "";
   Schema response = schemaServiceClient.createSchema(parent, schema, schemaId);
 }
 

Parameters:

parent - Required. The name of the project in which to create the schema. Format is `projects/{project-id}`.

schema - Required. The schema object to create.

This schema's `name` parameter is ignored. The schema object returned by CreateSchema will have a `name` made using the given `parent` and `schema_id`.

schemaId - The ID to use for the schema, which will become the final component of the schema's resource name.

See https://cloud.google.com/pubsub/docs/admin#resource_names for resource name constraints.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createSchema

public final Schema createSchema(String parent,
                                 Schema schema,
                                 String schemaId)

Creates a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Schema schema = Schema.newBuilder().build();
   String schemaId = "";
   Schema response = schemaServiceClient.createSchema(parent.toString(), schema, schemaId);
 }
 

Parameters:

parent - Required. The name of the project in which to create the schema. Format is `projects/{project-id}`.

schema - Required. The schema object to create.

This schema's `name` parameter is ignored. The schema object returned by CreateSchema will have a `name` made using the given `parent` and `schema_id`.

schemaId - The ID to use for the schema, which will become the final component of the schema's resource name.

See https://cloud.google.com/pubsub/docs/admin#resource_names for resource name constraints.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createSchema

public final Schema createSchema(CreateSchemaRequest request)

Creates a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Schema schema = Schema.newBuilder().build();
   CreateSchemaRequest request = CreateSchemaRequest.newBuilder()
     .setParent(parent.toString())
     .setSchema(schema)
     .build();
   Schema response = schemaServiceClient.createSchema(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

createSchemaCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateSchemaRequest,Schema> createSchemaCallable()

Creates a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Schema schema = Schema.newBuilder().build();
   CreateSchemaRequest request = CreateSchemaRequest.newBuilder()
     .setParent(parent.toString())
     .setSchema(schema)
     .build();
   ApiFuture<Schema> future = schemaServiceClient.createSchemaCallable().futureCall(request);
   // Do something
   Schema response = future.get();
 }
 

getSchema

public final Schema getSchema(SchemaName name)

Gets a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name = SchemaName.of("[PROJECT]", "[SCHEMA]");
   Schema response = schemaServiceClient.getSchema(name);
 }
 

Parameters:

name - Required. The name of the schema to get. Format is `projects/{project}/schemas/{schema}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSchema

public final Schema getSchema(String name)

Gets a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name = SchemaName.of("[PROJECT]", "[SCHEMA]");
   Schema response = schemaServiceClient.getSchema(name.toString());
 }
 

Parameters:

name - Required. The name of the schema to get. Format is `projects/{project}/schemas/{schema}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSchema

public final Schema getSchema(GetSchemaRequest request)

Gets a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name = SchemaName.of("[PROJECT]", "[SCHEMA]");
   GetSchemaRequest request = GetSchemaRequest.newBuilder()
     .setName(name.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.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name = SchemaName.of("[PROJECT]", "[SCHEMA]");
   GetSchemaRequest request = GetSchemaRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Schema> future = schemaServiceClient.getSchemaCallable().futureCall(request);
   // Do something
   Schema response = future.get();
 }
 

listSchemas

public final SchemaServiceClient.ListSchemasPagedResponse listSchemas(ProjectName parent)

Lists schemas in a project.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Schema element : schemaServiceClient.listSchemas(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The name of the project in which to list schemas. Format is `projects/{project-id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSchemas

public final SchemaServiceClient.ListSchemasPagedResponse listSchemas(String parent)

Lists schemas in a project.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Schema element : schemaServiceClient.listSchemas(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The name of the project in which to list schemas. Format is `projects/{project-id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSchemas

public final SchemaServiceClient.ListSchemasPagedResponse listSchemas(ListSchemasRequest request)

Lists schemas in a project.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ListSchemasRequest request = ListSchemasRequest.newBuilder()
     .setParent(parent.toString())
     .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()

Lists schemas in a project.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ListSchemasRequest request = ListSchemasRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListSchemasPagedResponse> 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()

Lists schemas in a project.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ListSchemasRequest request = ListSchemasRequest.newBuilder()
     .setParent(parent.toString())
     .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;
     }
   }
 }
 

deleteSchema

public final void deleteSchema(SchemaName name)

Deletes a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name = SchemaName.of("[PROJECT]", "[SCHEMA]");
   schemaServiceClient.deleteSchema(name);
 }
 

Parameters:

name - Required. Name of the schema to delete. Format is `projects/{project}/schemas/{schema}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteSchema

public final void deleteSchema(String name)

Deletes a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name = SchemaName.of("[PROJECT]", "[SCHEMA]");
   schemaServiceClient.deleteSchema(name.toString());
 }
 

Parameters:

name - Required. Name of the schema to delete. Format is `projects/{project}/schemas/{schema}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteSchema

public final void deleteSchema(DeleteSchemaRequest request)

Deletes a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name = SchemaName.of("[PROJECT]", "[SCHEMA]");
   DeleteSchemaRequest request = DeleteSchemaRequest.newBuilder()
     .setName(name.toString())
     .build();
   schemaServiceClient.deleteSchema(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

deleteSchemaCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteSchemaRequest,com.google.protobuf.Empty> deleteSchemaCallable()

Deletes a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name = SchemaName.of("[PROJECT]", "[SCHEMA]");
   DeleteSchemaRequest request = DeleteSchemaRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = schemaServiceClient.deleteSchemaCallable().futureCall(request);
   // Do something
   future.get();
 }
 

validateSchema

public final ValidateSchemaResponse validateSchema(ProjectName parent,
                                                   Schema schema)

Validates a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Schema schema = Schema.newBuilder().build();
   ValidateSchemaResponse response = schemaServiceClient.validateSchema(parent, schema);
 }
 

Parameters:

parent - Required. The name of the project in which to validate schemas. Format is `projects/{project-id}`.

schema - Required. The schema object to validate.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

validateSchema

public final ValidateSchemaResponse validateSchema(String parent,
                                                   Schema schema)

Validates a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Schema schema = Schema.newBuilder().build();
   ValidateSchemaResponse response = schemaServiceClient.validateSchema(parent.toString(), schema);
 }
 

Parameters:

parent - Required. The name of the project in which to validate schemas. Format is `projects/{project-id}`.

schema - Required. The schema object to validate.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

validateSchema

public final ValidateSchemaResponse validateSchema(ValidateSchemaRequest request)

Validates a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Schema schema = Schema.newBuilder().build();
   ValidateSchemaRequest request = ValidateSchemaRequest.newBuilder()
     .setParent(parent.toString())
     .setSchema(schema)
     .build();
   ValidateSchemaResponse response = schemaServiceClient.validateSchema(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

validateSchemaCallable

public final com.google.api.gax.rpc.UnaryCallable<ValidateSchemaRequest,ValidateSchemaResponse> validateSchemaCallable()

Validates a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Schema schema = Schema.newBuilder().build();
   ValidateSchemaRequest request = ValidateSchemaRequest.newBuilder()
     .setParent(parent.toString())
     .setSchema(schema)
     .build();
   ApiFuture<ValidateSchemaResponse> future = schemaServiceClient.validateSchemaCallable().futureCall(request);
   // Do something
   ValidateSchemaResponse response = future.get();
 }
 

validateMessage

public final ValidateMessageResponse validateMessage(ValidateMessageRequest request)

Validates a message against a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ValidateMessageRequest request = ValidateMessageRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ValidateMessageResponse response = schemaServiceClient.validateMessage(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

validateMessageCallable

public final com.google.api.gax.rpc.UnaryCallable<ValidateMessageRequest,ValidateMessageResponse> validateMessageCallable()

Validates a message against a schema.

Sample code:

 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ValidateMessageRequest request = ValidateMessageRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ValidateMessageResponse> future = schemaServiceClient.validateMessageCallable().futureCall(request);
   // Do something
   ValidateMessageResponse 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