Class ContentServiceClient (2.27.0)

Version 2.27.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 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
• 2.11.0

ContentService manages Notebook and SQL Scripts for Dataplex.

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

ContentServiceClient(ContentServiceClient const &)

Copy and move support

Parameter
Name	Description
	ContentServiceClient const &

ContentServiceClient(ContentServiceClient &&)

Copy and move support

Parameter
Name	Description
	ContentServiceClient &&

ContentServiceClient(std::shared_ptr< ContentServiceConnection >, Options)

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

Operators

operator=(ContentServiceClient const &)

Copy and move support

Parameter
Name	Description
	ContentServiceClient const &

Returns
Type	Description
ContentServiceClient &

operator=(ContentServiceClient &&)

Copy and move support

Parameter
Name	Description
	ContentServiceClient &&

Returns
Type	Description
ContentServiceClient &

Functions

CreateContent(std::string const &, google::cloud::dataplex::v1::Content const &, Options)

Create a content.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
content	google::cloud::dataplex::v1::Content const & Required. Content resource.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

CreateContent(google::cloud::dataplex::v1::CreateContentRequest const &, Options)

Create a content.

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

UpdateContent(google::cloud::dataplex::v1::Content const &, google::protobuf::FieldMask const &, Options)

Update a content.

Only supports full resource update.

Parameters
Name	Description
content	google::cloud::dataplex::v1::Content const & Required. Update description. Only fields specified in update_mask are updated.
update_mask	google::protobuf::FieldMask const & Required. Mask of fields to update.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateContent(google::cloud::dataplex::v1::UpdateContentRequest const &, Options)

Update a content.

Only supports full resource update.

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

DeleteContent(std::string const &, Options)

Delete a content.

Parameters
Name	Description
name	std::string const & Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
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.

DeleteContent(google::cloud::dataplex::v1::DeleteContentRequest const &, Options)

Delete a content.

Parameters
Name	Description
request	google::cloud::dataplex::v1::DeleteContentRequest 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.dataplex.v1.DeleteContentRequest. 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.

GetContent(std::string const &, Options)

Get a content resource.

Parameters
Name	Description
name	std::string const & Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetContent(google::cloud::dataplex::v1::GetContentRequest const &, Options)

Get a content resource.

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

GetIamPolicy(std::string const &, Options)

Gets the access control policy for a contentitem resource.

A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource.

Parameters
Name	Description
resource	std::string const & REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

Gets the access control policy for a contentitem resource.

A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource.

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

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Sets the access control policy on the specified contentitem resource.

Replaces any existing policy.

Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource.

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

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

Returns the caller's permissions on a resource.

If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).

A caller is not required to have Google IAM permission to make this request.

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

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

ListContent(std::string const &, Options)

List content.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

ListContent(google::cloud::dataplex::v1::ListContentRequest, Options)

List content.

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