Dataplex V1 API - Class Google::Cloud::Dataplex::V1::ContentService::Client (v0.10.1)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::ContentService::Client.

Client for the ContentService service.

ContentService manages Notebook and SQL Scripts for Dataplex.

Inherits

Object

Includes

Google::Cloud::Dataplex::V1::ContentService::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the ContentService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all ContentService clients
::Google::Cloud::Dataplex::V1::ContentService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the ContentService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_content

def create_content(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Content
def create_content(parent: nil, content: nil, validate_only: nil) -> ::Google::Cloud::Dataplex::V1::Content

Create a content.

Overloads

def create_content(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Content

Pass arguments to create_content via a request object, either of type Google::Cloud::Dataplex::V1::CreateContentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::CreateContentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_content(parent: nil, content: nil, validate_only: nil) -> ::Google::Cloud::Dataplex::V1::Content

Pass arguments to create_content via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
content (::Google::Cloud::Dataplex::V1::Content, ::Hash) — Required. Content resource.
validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations. The default is false.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dataplex::V1::Content)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Dataplex::V1::Content)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::ContentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::CreateContentRequest.new

# Call the create_content method.
result = client.create_content request

# The returned object is of type Google::Cloud::Dataplex::V1::Content.
p result

#delete_content

def delete_content(request, options = nil) -> ::Google::Protobuf::Empty
def delete_content(name: nil) -> ::Google::Protobuf::Empty

Delete a content.

Overloads

def delete_content(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_content via a request object, either of type DeleteContentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::DeleteContentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_content(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_content via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::ContentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::DeleteContentRequest.new

# Call the delete_content method.
result = client.delete_content request

# The returned object is of type Google::Protobuf::Empty.
p result

#get_content

def get_content(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Content
def get_content(name: nil, view: nil) -> ::Google::Cloud::Dataplex::V1::Content

Get a content resource.

Overloads

def get_content(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Content

Pass arguments to get_content via a request object, either of type GetContentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::GetContentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_content(name: nil, view: nil) -> ::Google::Cloud::Dataplex::V1::Content

Pass arguments to get_content via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
view (::Google::Cloud::Dataplex::V1::GetContentRequest::ContentView) — Optional. Specify content view to make a partial request.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dataplex::V1::Content)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Dataplex::V1::Content)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::ContentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::GetContentRequest.new

# Call the get_content method.
result = client.get_content request

# The returned object is of type Google::Cloud::Dataplex::V1::Content.
p result

#get_iam_policy

def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy

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.

Overloads

def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy

Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.

Parameters

request (::Google::Iam::V1::GetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy

Pass arguments to get_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

resource (::String) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Iam::V1::Policy)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Iam::V1::Policy)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::ContentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::GetIamPolicyRequest.new

# Call the get_iam_policy method.
result = client.get_iam_policy request

# The returned object is of type Google::Iam::V1::Policy.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns

(Google::Iam::V1::IAMPolicy::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new ContentService client object.

Yields

(config) — Configure the ContentService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Dataplex::V1::ContentService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dataplex::V1::ContentService::Client.new do |config|
  config.timeout = 10.0
end

#list_content

def list_content(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Content>
def list_content(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Content>

List content.

Overloads

def list_content(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Content>

Pass arguments to list_content via a request object, either of type ListContentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::ListContentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_content(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Content>

Pass arguments to list_content via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
page_size (::Integer) — Optional. Maximum number of content to return. The service may return fewer than this value. If unspecified, at most 10 content will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token (::String) — Optional. Page token received from a previous ListContent call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListContent must match the call that provided the page token.
filter (::String) — Optional. Filter request. Filters are case-sensitive. The following formats are supported:

labels.key1 = "value1" labels:key1 type = "NOTEBOOK" type = "SQL_SCRIPT"

These restrictions can be coinjoined with AND, OR and NOT conjunctions.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Content>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Content>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::ContentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::ListContentRequest.new

# Call the list_content method.
result = client.list_content request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataplex::V1::Content.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns

(Google::Cloud::Location::Locations::Client)

#set_iam_policy

def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy

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.

Overloads

def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy

Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.

Parameters

request (::Google::Iam::V1::SetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy

Pass arguments to set_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

resource (::String) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

paths: "bindings, etag"

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Iam::V1::Policy)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Iam::V1::Policy)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::ContentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::SetIamPolicyRequest.new

# Call the set_iam_policy method.
result = client.set_iam_policy request

# The returned object is of type Google::Iam::V1::Policy.
p result

#test_iam_permissions

def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

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.

Overloads

def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.

Parameters

request (::Google::Iam::V1::TestIamPermissionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

Pass arguments to test_iam_permissions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

resource (::String) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions (::Array<::String>) — The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Iam::V1::TestIamPermissionsResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Iam::V1::TestIamPermissionsResponse)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::ContentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::TestIamPermissionsRequest.new

# Call the test_iam_permissions method.
result = client.test_iam_permissions request

# The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
p result

#update_content

def update_content(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Content
def update_content(update_mask: nil, content: nil, validate_only: nil) -> ::Google::Cloud::Dataplex::V1::Content

Update a content. Only supports full resource update.

Overloads

def update_content(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Content

Pass arguments to update_content via a request object, either of type UpdateContentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dataplex::V1::UpdateContentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_content(update_mask: nil, content: nil, validate_only: nil) -> ::Google::Cloud::Dataplex::V1::Content

Pass arguments to update_content via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Mask of fields to update.
content (::Google::Cloud::Dataplex::V1::Content, ::Hash) — Required. Update description. Only fields specified in update_mask are updated.
validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations. The default is false.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dataplex::V1::Content)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Dataplex::V1::Content)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/dataplex/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataplex::V1::ContentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::UpdateContentRequest.new

# Call the update_content method.
result = client.update_content request

# The returned object is of type Google::Cloud::Dataplex::V1::Content.
p result