Service for doing schema-related operations.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
SchemaServiceClient(SchemaServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SchemaServiceClient const &
|
SchemaServiceClient(SchemaServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SchemaServiceClient &&
|
SchemaServiceClient(std::shared_ptr< SchemaServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< SchemaServiceConnection >
|
opts |
Options
|
Operators
operator=(SchemaServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SchemaServiceClient const &
|
Returns | |
---|---|
Type | Description |
SchemaServiceClient & |
operator=(SchemaServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SchemaServiceClient &&
|
Returns | |
---|---|
Type | Description |
SchemaServiceClient & |
Functions
CreateSchema(std::string const &, google::pubsub::v1::Schema const &, std::string const &, Options)
Creates a schema.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of the project in which to create the schema. Format is |
schema |
google::pubsub::v1::Schema const &
Required. The schema object to create. |
schema_id |
std::string const &
The ID to use for the schema, which will become the final component of the schema's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::pubsub::v1::Schema > |
the result of the RPC. The response message type (google.pubsub.v1.Schema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateSchema(google::pubsub::v1::CreateSchemaRequest const &, Options)
Creates a schema.
Parameters | |
---|---|
Name | Description |
request |
google::pubsub::v1::CreateSchemaRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::pubsub::v1::Schema > |
the result of the RPC. The response message type (google.pubsub.v1.Schema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSchema(std::string const &, Options)
Gets a schema.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the schema to get. Format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::pubsub::v1::Schema > |
the result of the RPC. The response message type (google.pubsub.v1.Schema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSchema(google::pubsub::v1::GetSchemaRequest const &, Options)
Gets a schema.
Parameters | |
---|---|
Name | Description |
request |
google::pubsub::v1::GetSchemaRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::pubsub::v1::Schema > |
the result of the RPC. The response message type (google.pubsub.v1.Schema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListSchemas(std::string const &, Options)
Lists schemas in a project.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of the project in which to list schemas. Format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::pubsub::v1::Schema > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSchemas(google::pubsub::v1::ListSchemasRequest, Options)
Lists schemas in a project.
Parameters | |
---|---|
Name | Description |
request |
google::pubsub::v1::ListSchemasRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::pubsub::v1::Schema > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSchemaRevisions(std::string const &, Options)
Lists all schema revisions for the named schema.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the schema to list revisions for. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::pubsub::v1::Schema > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSchemaRevisions(google::pubsub::v1::ListSchemaRevisionsRequest, Options)
Lists all schema revisions for the named schema.
Parameters | |
---|---|
Name | Description |
request |
google::pubsub::v1::ListSchemaRevisionsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::pubsub::v1::Schema > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CommitSchema(std::string const &, google::pubsub::v1::Schema const &, Options)
Commits a new schema revision to an existing schema.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the schema we are revising. Format is |
schema |
google::pubsub::v1::Schema const &
Required. The schema revision to commit. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::pubsub::v1::Schema > |
the result of the RPC. The response message type (google.pubsub.v1.Schema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CommitSchema(google::pubsub::v1::CommitSchemaRequest const &, Options)
Commits a new schema revision to an existing schema.
Parameters | |
---|---|
Name | Description |
request |
google::pubsub::v1::CommitSchemaRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::pubsub::v1::Schema > |
the result of the RPC. The response message type (google.pubsub.v1.Schema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RollbackSchema(std::string const &, std::string const &, Options)
Creates a new schema revision that is a copy of the provided revision_id.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The schema being rolled back with revision id. |
revision_id |
std::string const &
Required. The revision ID to roll back to. It must be a revision of the same schema. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::pubsub::v1::Schema > |
the result of the RPC. The response message type (google.pubsub.v1.Schema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RollbackSchema(google::pubsub::v1::RollbackSchemaRequest const &, Options)
Creates a new schema revision that is a copy of the provided revision_id.
Parameters | |
---|---|
Name | Description |
request |
google::pubsub::v1::RollbackSchemaRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::pubsub::v1::Schema > |
the result of the RPC. The response message type (google.pubsub.v1.Schema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteSchemaRevision(std::string const &, std::string const &, Options)
Deletes a specific schema revision.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the schema revision to be deleted, with a revision ID explicitly included. |
revision_id |
std::string const &
Optional. This field is deprecated and should not be used for specifying the revision ID. The revision ID should be specified via the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::pubsub::v1::Schema > |
the result of the RPC. The response message type (google.pubsub.v1.Schema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteSchemaRevision(google::pubsub::v1::DeleteSchemaRevisionRequest const &, Options)
Deletes a specific schema revision.
Parameters | |
---|---|
Name | Description |
request |
google::pubsub::v1::DeleteSchemaRevisionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::pubsub::v1::Schema > |
the result of the RPC. The response message type (google.pubsub.v1.Schema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteSchema(std::string const &, Options)
Deletes a schema.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the schema to delete. Format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteSchema(google::pubsub::v1::DeleteSchemaRequest const &, Options)
Deletes a schema.
Parameters | |
---|---|
Name | Description |
request |
google::pubsub::v1::DeleteSchemaRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
ValidateSchema(std::string const &, google::pubsub::v1::Schema const &, Options)
Validates a schema.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of the project in which to validate schemas. Format is |
schema |
google::pubsub::v1::Schema const &
Required. The schema object to validate. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::pubsub::v1::ValidateSchemaResponse > |
the result of the RPC. The response message type (google.pubsub.v1.ValidateSchemaResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ValidateSchema(google::pubsub::v1::ValidateSchemaRequest const &, Options)
Validates a schema.
Parameters | |
---|---|
Name | Description |
request |
google::pubsub::v1::ValidateSchemaRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::pubsub::v1::ValidateSchemaResponse > |
the result of the RPC. The response message type (google.pubsub.v1.ValidateSchemaResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ValidateMessage(google::pubsub::v1::ValidateMessageRequest const &, Options)
Validates a message against a schema.
Parameters | |
---|---|
Name | Description |
request |
google::pubsub::v1::ValidateMessageRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::pubsub::v1::ValidateMessageResponse > |
the result of the RPC. The response message type (google.pubsub.v1.ValidateMessageResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |