Class SchemaServiceClient (2.16.0-rc)

Service for managing Schemas.

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
NameDescription
SchemaServiceClient const &

SchemaServiceClient(SchemaServiceClient &&)

Copy and move support

Parameter
NameDescription
SchemaServiceClient &&

SchemaServiceClient(std::shared_ptr< SchemaServiceConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< SchemaServiceConnection >
opts Options

Operators

operator=(SchemaServiceClient const &)

Copy and move support

Parameter
NameDescription
SchemaServiceClient const &
Returns
TypeDescription
SchemaServiceClient &

operator=(SchemaServiceClient &&)

Copy and move support

Parameter
NameDescription
SchemaServiceClient &&
Returns
TypeDescription
SchemaServiceClient &

Functions

GetSchema(std::string const &, Options)

Gets a Schema.

Parameters
NameDescription
name std::string const &

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

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::discoveryengine::v1::Schema >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.Schema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSchema(google::cloud::discoveryengine::v1::GetSchemaRequest const &, Options)

Gets a Schema.

Parameters
NameDescription
request google::cloud::discoveryengine::v1::GetSchemaRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.GetSchemaRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::discoveryengine::v1::Schema >

the result of the RPC. The response message type (google.cloud.discoveryengine.v1.Schema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListSchemas(std::string const &, Options)

Gets a list of Schemas.

Parameters
NameDescription
parent std::string const &

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

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::cloud::discoveryengine::v1::Schema >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.discoveryengine.v1.Schema, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSchemas(google::cloud::discoveryengine::v1::ListSchemasRequest, Options)

Gets a list of Schemas.

Parameters
NameDescription
request google::cloud::discoveryengine::v1::ListSchemasRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.ListSchemasRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::cloud::discoveryengine::v1::Schema >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.discoveryengine.v1.Schema, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateSchema(std::string const &, google::cloud::discoveryengine::v1::Schema const &, std::string const &, Options)

Creates a Schema.

Parameters
NameDescription
parent std::string const &

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

schema google::cloud::discoveryengine::v1::Schema const &

Required. The Schema to create.

schema_id std::string const &

Required. The ID to use for the Schema, which will become the final component of the [Schema.name][google.cloud.discoveryengine.v1.Schema.name].
This field should conform to RFC-1034 standard with a length limit of 63 characters.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::discoveryengine::v1::Schema > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.Schema proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateSchema(google::cloud::discoveryengine::v1::CreateSchemaRequest const &, Options)

Creates a Schema.

Parameters
NameDescription
request google::cloud::discoveryengine::v1::CreateSchemaRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.CreateSchemaRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::discoveryengine::v1::Schema > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.Schema proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateSchema(google::cloud::discoveryengine::v1::UpdateSchemaRequest const &, Options)

Updates a Schema.

Parameters
NameDescription
request google::cloud::discoveryengine::v1::UpdateSchemaRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.UpdateSchemaRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::discoveryengine::v1::Schema > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.Schema proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteSchema(std::string const &, Options)

Deletes a Schema.

Parameters
NameDescription
name std::string const &

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

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::discoveryengine::v1::DeleteSchemaMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.DeleteSchemaMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteSchema(google::cloud::discoveryengine::v1::DeleteSchemaRequest const &, Options)

Deletes a Schema.

Parameters
NameDescription
request google::cloud::discoveryengine::v1::DeleteSchemaRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.DeleteSchemaRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::discoveryengine::v1::DeleteSchemaMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.DeleteSchemaMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.