Class SchemaServiceClient (1.120.6)

public class SchemaServiceClient implements 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:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Schema schema = Schema.newBuilder().build();
   String schemaId = "schemaId-697673060";
   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:

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


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 SchemaServiceSettings schemaServiceSettings =
     SchemaServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SchemaServiceClient schemaServiceClient = SchemaServiceClient.create(schemaServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 SchemaServiceSettings schemaServiceSettings =
     SchemaServiceSettings.newBuilder()
         .setTransportChannelProvider(
             SchemaServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 SchemaServiceClient schemaServiceClient = SchemaServiceClient.create(schemaServiceSettings);

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

Inheritance

java.lang.Object > SchemaServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

createSchema(CreateSchemaRequest request)

public final Schema createSchema(CreateSchemaRequest request)

Creates a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   CreateSchemaRequest request =
       CreateSchemaRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setSchema(Schema.newBuilder().build())
           .setSchemaId("schemaId-697673060")
           .build();
   Schema response = schemaServiceClient.createSchema(request);
 }

Parameter

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

Returns

Type	Description
Schema

createSchema(ProjectName parent, Schema schema, String schemaId)

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

Creates a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Schema schema = Schema.newBuilder().build();
   String schemaId = "schemaId-697673060";
   Schema response = schemaServiceClient.createSchema(parent, schema, schemaId);
 }

Parameters

Name	Description
parent	`ProjectName` Required. The name of the project in which to create the schema. Format is `projects/{project-id}`.
schema	`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	`String` 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.

Returns

Type	Description
Schema

createSchema(String parent, Schema schema, String schemaId)

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

Creates a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   Schema schema = Schema.newBuilder().build();
   String schemaId = "schemaId-697673060";
   Schema response = schemaServiceClient.createSchema(parent, schema, schemaId);
 }

Parameters

Name	Description
parent	`String` Required. The name of the project in which to create the schema. Format is `projects/{project-id}`.
schema	`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	`String` 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.

Returns

Type	Description
Schema

createSchemaCallable()

public final UnaryCallable<CreateSchemaRequest,Schema> createSchemaCallable()

Creates a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   CreateSchemaRequest request =
       CreateSchemaRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setSchema(Schema.newBuilder().build())
           .setSchemaId("schemaId-697673060")
           .build();
   ApiFuture<Schema> future = schemaServiceClient.createSchemaCallable().futureCall(request);
   // Do something.
   Schema response = future.get();
 }

Returns

Type	Description
UnaryCallable<CreateSchemaRequest,Schema>

deleteSchema(DeleteSchemaRequest request)

public final void deleteSchema(DeleteSchemaRequest request)

Deletes a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   DeleteSchemaRequest request =
       DeleteSchemaRequest.newBuilder()
           .setName(SchemaName.of("[PROJECT]", "[SCHEMA]").toString())
           .build();
   schemaServiceClient.deleteSchema(request);
 }

Parameter

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

deleteSchema(SchemaName name)

public final void deleteSchema(SchemaName name)

Deletes a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name = SchemaName.of("[PROJECT]", "[SCHEMA]");
   schemaServiceClient.deleteSchema(name);
 }

Parameter

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

deleteSchema(String name)

public final void deleteSchema(String name)

Deletes a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   String name = SchemaName.of("[PROJECT]", "[SCHEMA]").toString();
   schemaServiceClient.deleteSchema(name);
 }

Parameter

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

deleteSchemaCallable()

public final UnaryCallable<DeleteSchemaRequest,Empty> deleteSchemaCallable()

Deletes a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   DeleteSchemaRequest request =
       DeleteSchemaRequest.newBuilder()
           .setName(SchemaName.of("[PROJECT]", "[SCHEMA]").toString())
           .build();
   ApiFuture<Empty> future = schemaServiceClient.deleteSchemaCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
UnaryCallable<DeleteSchemaRequest,Empty>

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(SchemaName.of("[PROJECT]", "[SCHEMA]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = schemaServiceClient.getIamPolicy(request);
 }

Parameter

Name	Description
request	`com.google.iam.v1.GetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(SchemaName.of("[PROJECT]", "[SCHEMA]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = schemaServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns

Type	Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getSchema(GetSchemaRequest request)

public final Schema getSchema(GetSchemaRequest request)

Gets a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   GetSchemaRequest request =
       GetSchemaRequest.newBuilder()
           .setName(SchemaName.of("[PROJECT]", "[SCHEMA]").toString())
           .setView(SchemaView.forNumber(0))
           .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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SchemaName name = SchemaName.of("[PROJECT]", "[SCHEMA]");
   Schema response = schemaServiceClient.getSchema(name);
 }

Parameter

Name	Description
name	`SchemaName` Required. The name of the schema to get. Format is `projects/{project}/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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   String name = SchemaName.of("[PROJECT]", "[SCHEMA]").toString();
   Schema response = schemaServiceClient.getSchema(name);
 }

Parameter

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

Returns

Type	Description
Schema

getSchemaCallable()

public final UnaryCallable<GetSchemaRequest,Schema> getSchemaCallable()

Gets a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   GetSchemaRequest request =
       GetSchemaRequest.newBuilder()
           .setName(SchemaName.of("[PROJECT]", "[SCHEMA]").toString())
           .setView(SchemaView.forNumber(0))
           .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(ListSchemasRequest request)

public final SchemaServiceClient.ListSchemasPagedResponse listSchemas(ListSchemasRequest request)

Lists schemas in a project.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ListSchemasRequest request =
       ListSchemasRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setView(SchemaView.forNumber(0))
           .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(ProjectName parent)

public final SchemaServiceClient.ListSchemasPagedResponse listSchemas(ProjectName parent)

Lists schemas in a project.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Schema element : schemaServiceClient.listSchemas(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
SchemaServiceClient.ListSchemasPagedResponse

listSchemas(String parent)

public final SchemaServiceClient.ListSchemasPagedResponse listSchemas(String parent)

Lists schemas in a project.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (Schema element : schemaServiceClient.listSchemas(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
SchemaServiceClient.ListSchemasPagedResponse

listSchemasCallable()

public final UnaryCallable<ListSchemasRequest,ListSchemasResponse> listSchemasCallable()

Lists schemas in a project.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ListSchemasRequest request =
       ListSchemasRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setView(SchemaView.forNumber(0))
           .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()

Lists schemas in a project.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ListSchemasRequest request =
       ListSchemasRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setView(SchemaView.forNumber(0))
           .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>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(SchemaName.of("[PROJECT]", "[SCHEMA]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = schemaServiceClient.setIamPolicy(request);
 }

Parameter

Name	Description
request	`com.google.iam.v1.SetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(SchemaName.of("[PROJECT]", "[SCHEMA]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = schemaServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns

Type	Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(SchemaName.of("[PROJECT]", "[SCHEMA]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = schemaServiceClient.testIamPermissions(request);
 }

Parameter

Name	Description
request	`com.google.iam.v1.TestIamPermissionsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(SchemaName.of("[PROJECT]", "[SCHEMA]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       schemaServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

Returns

Type	Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

validateMessage(ValidateMessageRequest request)

public final ValidateMessageResponse validateMessage(ValidateMessageRequest request)

Validates a message against a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ValidateMessageRequest request =
       ValidateMessageRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setMessage(ByteString.EMPTY)
           .setEncoding(Encoding.forNumber(0))
           .build();
   ValidateMessageResponse response = schemaServiceClient.validateMessage(request);
 }

Parameter

Name	Description
request	`ValidateMessageRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
ValidateMessageResponse

validateMessageCallable()

public final UnaryCallable<ValidateMessageRequest,ValidateMessageResponse> validateMessageCallable()

Validates a message against a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ValidateMessageRequest request =
       ValidateMessageRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setMessage(ByteString.EMPTY)
           .setEncoding(Encoding.forNumber(0))
           .build();
   ApiFuture<ValidateMessageResponse> future =
       schemaServiceClient.validateMessageCallable().futureCall(request);
   // Do something.
   ValidateMessageResponse response = future.get();
 }

Returns

Type	Description
UnaryCallable<ValidateMessageRequest,ValidateMessageResponse>

validateSchema(ProjectName parent, Schema schema)

public final ValidateSchemaResponse validateSchema(ProjectName parent, Schema schema)

Validates a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Schema schema = Schema.newBuilder().build();
   ValidateSchemaResponse response = schemaServiceClient.validateSchema(parent, schema);
 }

Parameters

Name	Description
parent	`ProjectName` Required. The name of the project in which to validate schemas. Format is `projects/{project-id}`.
schema	`Schema` Required. The schema object to validate.

Returns

Type	Description
ValidateSchemaResponse

validateSchema(ValidateSchemaRequest request)

public final ValidateSchemaResponse validateSchema(ValidateSchemaRequest request)

Validates a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ValidateSchemaRequest request =
       ValidateSchemaRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setSchema(Schema.newBuilder().build())
           .build();
   ValidateSchemaResponse response = schemaServiceClient.validateSchema(request);
 }

Parameter

Name	Description
request	`ValidateSchemaRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
ValidateSchemaResponse

validateSchema(String parent, Schema schema)

public final ValidateSchemaResponse validateSchema(String parent, Schema schema)

Validates a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   Schema schema = Schema.newBuilder().build();
   ValidateSchemaResponse response = schemaServiceClient.validateSchema(parent, schema);
 }

Parameters

Name	Description
parent	`String` Required. The name of the project in which to validate schemas. Format is `projects/{project-id}`.
schema	`Schema` Required. The schema object to validate.

Returns

Type	Description
ValidateSchemaResponse

validateSchemaCallable()

public final UnaryCallable<ValidateSchemaRequest,ValidateSchemaResponse> validateSchemaCallable()

Validates a schema.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
   ValidateSchemaRequest request =
       ValidateSchemaRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setSchema(Schema.newBuilder().build())
           .build();
   ApiFuture<ValidateSchemaResponse> future =
       schemaServiceClient.validateSchemaCallable().futureCall(request);
   // Do something.
   ValidateSchemaResponse response = future.get();
 }

Returns

Type	Description
UnaryCallable<ValidateSchemaRequest,ValidateSchemaResponse>