Class DocumentSchemaServiceClient (2.31.0)

Version 2.31.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0

This service lets you manage document schema.

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

DocumentSchemaServiceClient(DocumentSchemaServiceClient const &)

Copy and move support

Parameter
Name	Description
	DocumentSchemaServiceClient const &

DocumentSchemaServiceClient(DocumentSchemaServiceClient &&)

Copy and move support

Parameter
Name	Description
	DocumentSchemaServiceClient &&

DocumentSchemaServiceClient(std::shared_ptr< DocumentSchemaServiceConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< DocumentSchemaServiceConnection >
opts	Options

Operators

operator=(DocumentSchemaServiceClient const &)

Copy and move support

Parameter
Name	Description
	DocumentSchemaServiceClient const &

Returns
Type	Description
DocumentSchemaServiceClient &

operator=(DocumentSchemaServiceClient &&)

Copy and move support

Parameter
Name	Description
	DocumentSchemaServiceClient &&

Returns
Type	Description
DocumentSchemaServiceClient &

Functions

CreateDocumentSchema(std::string const &, google::cloud::contentwarehouse::v1::DocumentSchema const &, Options)

Creates a document schema.

Parameters
Name	Description
parent	std::string const & Required. The parent name.
document_schema	google::cloud::contentwarehouse::v1::DocumentSchema const & Required. The document schema to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::contentwarehouse::v1::DocumentSchema >	the result of the RPC. The response message type (google.cloud.contentwarehouse.v1.DocumentSchema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateDocumentSchema(google::cloud::contentwarehouse::v1::CreateDocumentSchemaRequest const &, Options)

Creates a document schema.

Parameters
Name	Description
request	google::cloud::contentwarehouse::v1::CreateDocumentSchemaRequest 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.contentwarehouse.v1.CreateDocumentSchemaRequest. 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
Type	Description
StatusOr< google::cloud::contentwarehouse::v1::DocumentSchema >	the result of the RPC. The response message type (google.cloud.contentwarehouse.v1.DocumentSchema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateDocumentSchema(std::string const &, google::cloud::contentwarehouse::v1::DocumentSchema const &, Options)

Updates a Document Schema.

Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT.

Parameters
Name	Description
name	std::string const & Required. The name of the document schema to update. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
document_schema	google::cloud::contentwarehouse::v1::DocumentSchema const & Required. The document schema to update with.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::contentwarehouse::v1::DocumentSchema >	the result of the RPC. The response message type (google.cloud.contentwarehouse.v1.DocumentSchema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateDocumentSchema(google::cloud::contentwarehouse::v1::UpdateDocumentSchemaRequest const &, Options)

Updates a Document Schema.

Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT.

Parameters
Name	Description
request	google::cloud::contentwarehouse::v1::UpdateDocumentSchemaRequest 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.contentwarehouse.v1.UpdateDocumentSchemaRequest. 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
Type	Description
StatusOr< google::cloud::contentwarehouse::v1::DocumentSchema >	the result of the RPC. The response message type (google.cloud.contentwarehouse.v1.DocumentSchema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetDocumentSchema(std::string const &, Options)

Gets a document schema.

Returns NOT_FOUND if the document schema does not exist.

Parameters
Name	Description
name	std::string const & Required. The name of the document schema to retrieve.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::contentwarehouse::v1::DocumentSchema >	the result of the RPC. The response message type (google.cloud.contentwarehouse.v1.DocumentSchema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetDocumentSchema(google::cloud::contentwarehouse::v1::GetDocumentSchemaRequest const &, Options)

Gets a document schema.

Returns NOT_FOUND if the document schema does not exist.

Parameters
Name	Description
request	google::cloud::contentwarehouse::v1::GetDocumentSchemaRequest 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.contentwarehouse.v1.GetDocumentSchemaRequest. 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
Type	Description
StatusOr< google::cloud::contentwarehouse::v1::DocumentSchema >	the result of the RPC. The response message type (google.cloud.contentwarehouse.v1.DocumentSchema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteDocumentSchema(std::string const &, Options)

Deletes a document schema.

Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it.

Parameters
Name	Description
name	std::string const & Required. The name of the document schema to delete.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteDocumentSchema(google::cloud::contentwarehouse::v1::DeleteDocumentSchemaRequest const &, Options)

Deletes a document schema.

Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it.

Parameters
Name	Description
request	google::cloud::contentwarehouse::v1::DeleteDocumentSchemaRequest 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.contentwarehouse.v1.DeleteDocumentSchemaRequest. 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
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

ListDocumentSchemas(std::string const &, Options)

Lists document schemas.

Parameters
Name	Description
parent	std::string const & Required. The parent, which owns this collection of document schemas. Format: projects/{project_number}/locations/{location}.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::contentwarehouse::v1::DocumentSchema >	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.contentwarehouse.v1.DocumentSchema, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDocumentSchemas(google::cloud::contentwarehouse::v1::ListDocumentSchemasRequest, Options)

Lists document schemas.

Parameters
Name	Description
request	google::cloud::contentwarehouse::v1::ListDocumentSchemasRequest 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.contentwarehouse.v1.ListDocumentSchemasRequest. 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
Type	Description
StreamRange< google::cloud::contentwarehouse::v1::DocumentSchema >	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.contentwarehouse.v1.DocumentSchema, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
name	std::string const & The name of the operation resource.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::longrunning::Operation >	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
request	google::longrunning::GetOperationRequest 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.longrunning.GetOperationRequest. 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
Type	Description
StatusOr< google::longrunning::Operation >	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.