google-api-ruby-client/generated/google-apis-dataplex_v1/lib/google/apis/dataplex_v1/service.rb

2793 lines
180 KiB
Ruby
Raw Normal View History

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module DataplexV1
# Cloud Dataplex API
#
# Dataplex API is used to manage the lifecycle of data lakes.
#
# @example
# require 'google/apis/dataplex_v1'
#
# Dataplex = Google::Apis::DataplexV1 # Alias the module
# service = Dataplex::CloudDataplexService.new
#
# @see https://cloud.google.com/dataplex/docs
class CloudDataplexService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://dataplex.googleapis.com/', '',
client_name: 'google-apis-dataplex_v1',
client_version: Google::Apis::DataplexV1::GEM_VERSION)
@batch_path = 'batch'
end
# Gets information about a location.
# @param [String] name
# Resource name for the location.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudLocationLocation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudLocationLocation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudLocationLocation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudLocationLocation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists information about the supported locations for this service.
# @param [String] name
# The resource that owns the locations collection, if applicable.
# @param [String] filter
# A filter to narrow down results to a preferred subset. The filtering language
# accepts strings like "displayName=tokyo", and is documented in more detail in
# AIP-160 (https://google.aip.dev/160).
# @param [Fixnum] page_size
# The maximum number of results to return. If not set, the service selects a
# default.
# @param [String] page_token
# A page token received from the next_page_token field in the response. Send
# that page token to receive the subsequent page.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudLocationListLocationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudLocationListLocationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}/locations', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudLocationListLocationsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudLocationListLocationsResponse
command.params['name'] = name unless name.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a lake resource.
# @param [String] parent
# Required. The resource name of the lake location, of the form: projects/`
# project_number`/locations/`location_id` where location_id refers to a GCP
# region.
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Lake] google_cloud_dataplex_v1_lake_object
# @param [String] lake_id
# Required. Lake identifier. This ID will be used to generate names such as
# database and dataset names when publishing metadata to Hive Metastore and
# BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must
# start with a letter. * Must end with a number or a letter. * Must be between 1-
# 63 characters. * Must be unique within the customer project / location.
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_location_lake(parent, google_cloud_dataplex_v1_lake_object = nil, lake_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/lakes', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Lake::Representation
command.request_object = google_cloud_dataplex_v1_lake_object
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['lakeId'] = lake_id unless lake_id.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a lake resource. All zones within the lake must be deleted before the
# lake can be deleted.
# @param [String] name
# Required. The resource name of the lake: projects/`project_number`/locations/`
# location_id`/lakes/`lake_id`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_location_lake(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves a lake resource.
# @param [String] name
# Required. The resource name of the lake: projects/`project_number`/locations/`
# location_id`/lakes/`lake_id`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Lake] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Lake]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Lake::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Lake
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The maximum policy version that will be used to format the policy.
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.Requests for policies with any conditional role bindings must specify
# version 3. Policies with no conditional role bindings may specify any valid
# value or leave the field unset.The policy in the response might use the policy
# version that you specified, or it might use a lower policy version. For
# example, if you specify version 3, but the policy has no conditional role
# bindings, the response uses version 1.To learn which resources support
# conditions in their IAM policies, see the IAM documentation (https://cloud.
# google.com/iam/help/conditions/resource-policies).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists lake resources in a project and location.
# @param [String] parent
# Required. The resource name of the lake location, of the form: projects/`
# project_number`/locations/`location_id` where location_id refers to a GCP
# region.
# @param [String] filter
# Optional. Filter request.
# @param [String] order_by
# Optional. Order by fields for the result.
# @param [Fixnum] page_size
# Optional. Maximum number of Lakes to return. The service may return fewer than
# this value. If unspecified, at most 10 lakes will be returned. The maximum
# value is 1000; values above 1000 will be coerced to 1000.
# @param [String] page_token
# Optional. Page token received from a previous ListLakes call. Provide this to
# retrieve the subsequent page. When paginating, all other parameters provided
# to ListLakes must match the call that provided the page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListLakesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListLakesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_lakes(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/lakes', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListLakesResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListLakesResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a lake resource.
# @param [String] name
# Output only. The relative resource name of the lake, of the form: projects/`
# project_number`/locations/`location_id`/lakes/`lake_id`.
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Lake] google_cloud_dataplex_v1_lake_object
# @param [String] update_mask
# Required. Mask of fields to update.
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_location_lake(name, google_cloud_dataplex_v1_lake_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Lake::Representation
command.request_object = google_cloud_dataplex_v1_lake_object
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
# errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_project_location_lake_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest::Representation
command.request_object = google_iam_v1_set_iam_policy_request_object
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified resource. If the
# resource does not exist, this will return an empty set of permissions, not a
# NOT_FOUND error.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.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1_test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_project_location_lake_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest::Representation
command.request_object = google_iam_v1_test_iam_permissions_request_object
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists action resources in a lake.
# @param [String] parent
# Required. The resource name of the parent lake: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id`
# @param [Fixnum] page_size
# Optional. Maximum number of actions to return. The service may return fewer
# than this value. If unspecified, at most 10 actions will be returned. The
# maximum value is 1000; values above 1000 will be coerced to 1000.
# @param [String] page_token
# Optional. Page token received from a previous ListLakeActions call. Provide
# this to retrieve the subsequent page. When paginating, all other parameters
# provided to ListLakeActions must match the call that provided the page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListActionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListActionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_lake_actions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/actions', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListActionsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListActionsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The maximum policy version that will be used to format the policy.
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.Requests for policies with any conditional role bindings must specify
# version 3. Policies with no conditional role bindings may specify any valid
# value or leave the field unset.The policy in the response might use the policy
# version that you specified, or it might use a lower policy version. For
# example, if you specify version 3, but the policy has no conditional role
# bindings, the response uses version 1.To learn which resources support
# conditions in their IAM policies, see the IAM documentation (https://cloud.
# google.com/iam/help/conditions/resource-policies).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_content_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
# errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_project_location_lake_content_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest::Representation
command.request_object = google_iam_v1_set_iam_policy_request_object
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified resource. If the
# resource does not exist, this will return an empty set of permissions, not a
# NOT_FOUND error.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.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1_test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_project_location_lake_content_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest::Representation
command.request_object = google_iam_v1_test_iam_permissions_request_object
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Create a content.
# @param [String] parent
# Required. The resource name of the parent lake: projects/`project_id`/
# locations/`location_id`/lakes/`lake_id`
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Content] google_cloud_dataplex_v1_content_object
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Content] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Content]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_location_lake_contentitem(parent, google_cloud_dataplex_v1_content_object = nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/contentitems', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Content::Representation
command.request_object = google_cloud_dataplex_v1_content_object
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Content::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Content
command.params['parent'] = parent unless parent.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete a content.
# @param [String] name
# Required. The resource name of the content: projects/`project_id`/locations/`
# location_id`/lakes/`lake_id`/content/`content_id`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_location_lake_contentitem(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::Empty::Representation
command.response_class = Google::Apis::DataplexV1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get a content resource.
# @param [String] name
# Required. The resource name of the content: projects/`project_id`/locations/`
# location_id`/lakes/`lake_id`/content/`content_id`
# @param [String] view
# Optional. Specify content view to make a partial request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Content] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Content]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_contentitem(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Content::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Content
command.params['name'] = name unless name.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# List content.
# @param [String] parent
# Required. The resource name of the parent lake: projects/`project_id`/
# locations/`location_id`/lakes/`lake_id`
# @param [String] filter
# 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.
# @param [Fixnum] page_size
# 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.
# @param [String] page_token
# 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.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListContentResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListContentResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_lake_contentitems(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/contentitems', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListContentResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListContentResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Update a content. Only supports full resource update.
# @param [String] name
# Output only. The relative resource name of the content, of the form: projects/`
# project_id`/locations/`location_id`/lakes/`lake_id`/content/`content_id`
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Content] google_cloud_dataplex_v1_content_object
# @param [String] update_mask
# Required. Mask of fields to update.
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Content] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Content]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_location_lake_contentitem(name, google_cloud_dataplex_v1_content_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Content::Representation
command.request_object = google_cloud_dataplex_v1_content_object
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Content::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Content
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Create an environment resource.
# @param [String] parent
# Required. The resource name of the parent lake: projects/`project_id`/
# locations/`location_id`/lakes/`lake_id`
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Environment] google_cloud_dataplex_v1_environment_object
# @param [String] environment_id
# Required. Environment identifier. * Must contain only lowercase letters,
# numbers and hyphens. * Must start with a letter. * Must be between 1-63
# characters. * Must end with a number or a letter. * Must be unique within the
# lake.
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_location_lake_environment(parent, google_cloud_dataplex_v1_environment_object = nil, environment_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/environments', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Environment::Representation
command.request_object = google_cloud_dataplex_v1_environment_object
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['environmentId'] = environment_id unless environment_id.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete the environment resource. All the child resources must have been
# deleted before environment deletion can be initiated.
# @param [String] name
# Required. The resource name of the environment: projects/`project_id`/
# locations/`location_id`/lakes/`lake_id`/environments/`environment_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_location_lake_environment(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get environment resource.
# @param [String] name
# Required. The resource name of the environment: projects/`project_id`/
# locations/`location_id`/lakes/`lake_id`/environments/`environment_id`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Environment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Environment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_environment(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Environment::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Environment
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The maximum policy version that will be used to format the policy.
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.Requests for policies with any conditional role bindings must specify
# version 3. Policies with no conditional role bindings may specify any valid
# value or leave the field unset.The policy in the response might use the policy
# version that you specified, or it might use a lower policy version. For
# example, if you specify version 3, but the policy has no conditional role
# bindings, the response uses version 1.To learn which resources support
# conditions in their IAM policies, see the IAM documentation (https://cloud.
# google.com/iam/help/conditions/resource-policies).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_environment_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists environments under the given lake.
# @param [String] parent
# Required. The resource name of the parent lake: projects/`project_id`/
# locations/`location_id`/lakes/`lake_id`
# @param [String] filter
# Optional. Filter request.
# @param [String] order_by
# Optional. Order by fields for the result.
# @param [Fixnum] page_size
# Optional. Maximum number of environments to return. The service may return
# fewer than this value. If unspecified, at most 10 environments will be
# returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
# @param [String] page_token
# Optional. Page token received from a previous ListEnvironments call. Provide
# this to retrieve the subsequent page. When paginating, all other parameters
# provided to ListEnvironments must match the call that provided the page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListEnvironmentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListEnvironmentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_lake_environments(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/environments', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListEnvironmentsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListEnvironmentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Update the environment resource.
# @param [String] name
# Output only. The relative resource name of the environment, of the form:
# projects/`project_id`/locations/`location_id`/lakes/`lake_id`/environment/`
# environment_id`
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Environment] google_cloud_dataplex_v1_environment_object
# @param [String] update_mask
# Required. Mask of fields to update.
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_location_lake_environment(name, google_cloud_dataplex_v1_environment_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Environment::Representation
command.request_object = google_cloud_dataplex_v1_environment_object
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
# errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_project_location_lake_environment_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest::Representation
command.request_object = google_iam_v1_set_iam_policy_request_object
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified resource. If the
# resource does not exist, this will return an empty set of permissions, not a
# NOT_FOUND error.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.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1_test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_project_location_lake_environment_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest::Representation
command.request_object = google_iam_v1_test_iam_permissions_request_object
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists session resources in an environment.
# @param [String] parent
# Required. The resource name of the parent environment: projects/`
# project_number`/locations/`location_id`/lakes/`lake_id`/environment/`
# environment_id`
# @param [Fixnum] page_size
# Optional. Maximum number of sessions to return. The service may return fewer
# than this value. If unspecified, at most 10 sessions will be returned. The
# maximum value is 1000; values above 1000 will be coerced to 1000.
# @param [String] page_token
# Optional. Page token received from a previous ListSessions call. Provide this
# to retrieve the subsequent page. When paginating, all other parameters
# provided to ListSessions must match the call that provided the page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListSessionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListSessionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_lake_environment_sessions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/sessions', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListSessionsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListSessionsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a task resource within a lake.
# @param [String] parent
# Required. The resource name of the parent lake: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id`
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Task] google_cloud_dataplex_v1_task_object
# @param [String] task_id
# Required. Task identifier.
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_location_lake_task(parent, google_cloud_dataplex_v1_task_object = nil, task_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/tasks', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Task::Representation
command.request_object = google_cloud_dataplex_v1_task_object
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['taskId'] = task_id unless task_id.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete the task resource.
# @param [String] name
# Required. The resource name of the task: projects/`project_number`/locations/`
# location_id`/lakes/`lake_id` /task/`task_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_location_lake_task(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get task resource.
# @param [String] name
# Required. The resource name of the task: projects/`project_number`/locations/`
# location_id`/lakes/`lake_id` /tasks/`tasks_id`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Task] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Task]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_task(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Task::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Task
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The maximum policy version that will be used to format the policy.
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.Requests for policies with any conditional role bindings must specify
# version 3. Policies with no conditional role bindings may specify any valid
# value or leave the field unset.The policy in the response might use the policy
# version that you specified, or it might use a lower policy version. For
# example, if you specify version 3, but the policy has no conditional role
# bindings, the response uses version 1.To learn which resources support
# conditions in their IAM policies, see the IAM documentation (https://cloud.
# google.com/iam/help/conditions/resource-policies).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_task_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists tasks under the given lake.
# @param [String] parent
# Required. The resource name of the parent lake: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id`
# @param [String] filter
# Optional. Filter request.
# @param [String] order_by
# Optional. Order by fields for the result.
# @param [Fixnum] page_size
# Optional. Maximum number of tasks to return. The service may return fewer than
# this value. If unspecified, at most 10 tasks will be returned. The maximum
# value is 1000; values above 1000 will be coerced to 1000.
# @param [String] page_token
# Optional. Page token received from a previous ListZones call. Provide this to
# retrieve the subsequent page. When paginating, all other parameters provided
# to ListZones must match the call that provided the page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListTasksResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListTasksResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_lake_tasks(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/tasks', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListTasksResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListTasksResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Update the task resource.
# @param [String] name
# Output only. The relative resource name of the task, of the form: projects/`
# project_number`/locations/`location_id`/lakes/`lake_id`/ tasks/`task_id`.
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Task] google_cloud_dataplex_v1_task_object
# @param [String] update_mask
# Required. Mask of fields to update.
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_location_lake_task(name, google_cloud_dataplex_v1_task_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Task::Representation
command.request_object = google_cloud_dataplex_v1_task_object
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
# errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_project_location_lake_task_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest::Representation
command.request_object = google_iam_v1_set_iam_policy_request_object
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified resource. If the
# resource does not exist, this will return an empty set of permissions, not a
# NOT_FOUND error.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.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1_test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_project_location_lake_task_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest::Representation
command.request_object = google_iam_v1_test_iam_permissions_request_object
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Cancel jobs running for the task resource.
# @param [String] name
# Required. The resource name of the job: projects/`project_number`/locations/`
# location_id`/lakes/`lake_id` /task/`task_id`/job/`job_id``
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1CancelJobRequest] google_cloud_dataplex_v1_cancel_job_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def cancel_project_location_lake_task_job(name, google_cloud_dataplex_v1_cancel_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1CancelJobRequest::Representation
command.request_object = google_cloud_dataplex_v1_cancel_job_request_object
command.response_representation = Google::Apis::DataplexV1::Empty::Representation
command.response_class = Google::Apis::DataplexV1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get job resource.
# @param [String] name
# Required. The resource name of the job: projects/`project_number`/locations/`
# location_id`/lakes/`lake_id` /tasks/`task_id`/jobs/`job_id`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Job] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Job]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_task_job(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Job::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Job
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists Jobs under the given task.
# @param [String] parent
# Required. The resource name of the parent environment: projects/`
# project_number`/locations/`location_id`/lakes/`lake_id`/tasks/`task_id`
# @param [Fixnum] page_size
# Optional. Maximum number of jobs to return. The service may return fewer than
# this value. If unspecified, at most 10 jobs will be returned. The maximum
# value is 1000; values above 1000 will be coerced to 1000.
# @param [String] page_token
# Optional. Page token received from a previous ListJobs call. Provide this to
# retrieve the subsequent page. When paginating, all other parameters provided
# to ListJobs must match the call that provided the page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListJobsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListJobsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_lake_task_jobs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/jobs', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListJobsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListJobsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a zone resource within a lake.
# @param [String] parent
# Required. The resource name of the parent lake: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id`
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Zone] google_cloud_dataplex_v1_zone_object
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] zone_id
# Required. Zone identifier. This ID will be used to generate names such as
# database and dataset names when publishing metadata to Hive Metastore and
# BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must
# start with a letter. * Must end with a number or a letter. * Must be between 1-
# 63 characters. * Must be unique across all lakes from all locations in a
# project. * Must not be one of the reserved IDs (i.e. "default", "global-temp")
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_location_lake_zone(parent, google_cloud_dataplex_v1_zone_object = nil, validate_only: nil, zone_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/zones', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Zone::Representation
command.request_object = google_cloud_dataplex_v1_zone_object
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['zoneId'] = zone_id unless zone_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a zone resource. All assets within a zone must be deleted before the
# zone can be deleted.
# @param [String] name
# Required. The resource name of the zone: projects/`project_number`/locations/`
# location_id`/lakes/`lake_id` /zones/`zone_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_location_lake_zone(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves a zone resource.
# @param [String] name
# Required. The resource name of the zone: projects/`project_number`/locations/`
# location_id`/lakes/`lake_id` /zones/`zone_id`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Zone] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Zone]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_zone(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Zone::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Zone
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The maximum policy version that will be used to format the policy.
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.Requests for policies with any conditional role bindings must specify
# version 3. Policies with no conditional role bindings may specify any valid
# value or leave the field unset.The policy in the response might use the policy
# version that you specified, or it might use a lower policy version. For
# example, if you specify version 3, but the policy has no conditional role
# bindings, the response uses version 1.To learn which resources support
# conditions in their IAM policies, see the IAM documentation (https://cloud.
# google.com/iam/help/conditions/resource-policies).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_zone_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists zone resources in a lake.
# @param [String] parent
# Required. The resource name of the parent lake: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id`
# @param [String] filter
# Optional. Filter request.
# @param [String] order_by
# Optional. Order by fields for the result.
# @param [Fixnum] page_size
# Optional. Maximum number of zones to return. The service may return fewer than
# this value. If unspecified, at most 10 zones will be returned. The maximum
# value is 1000; values above 1000 will be coerced to 1000.
# @param [String] page_token
# Optional. Page token received from a previous ListZones call. Provide this to
# retrieve the subsequent page. When paginating, all other parameters provided
# to ListZones must match the call that provided the page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListZonesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListZonesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_lake_zones(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/zones', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListZonesResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListZonesResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a zone resource.
# @param [String] name
# Output only. The relative resource name of the zone, of the form: projects/`
# project_number`/locations/`location_id`/lakes/`lake_id`/zones/`zone_id`.
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Zone] google_cloud_dataplex_v1_zone_object
# @param [String] update_mask
# Required. Mask of fields to update.
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_location_lake_zone(name, google_cloud_dataplex_v1_zone_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Zone::Representation
command.request_object = google_cloud_dataplex_v1_zone_object
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
# errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_project_location_lake_zone_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest::Representation
command.request_object = google_iam_v1_set_iam_policy_request_object
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified resource. If the
# resource does not exist, this will return an empty set of permissions, not a
# NOT_FOUND error.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.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1_test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_project_location_lake_zone_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest::Representation
command.request_object = google_iam_v1_test_iam_permissions_request_object
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists action resources in a zone.
# @param [String] parent
# Required. The resource name of the parent zone: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id`/zones/`zone_id`
# @param [Fixnum] page_size
# Optional. Maximum number of actions to return. The service may return fewer
# than this value. If unspecified, at most 10 actions will be returned. The
# maximum value is 1000; values above 1000 will be coerced to 1000.
# @param [String] page_token
# Optional. Page token received from a previous ListZoneActions call. Provide
# this to retrieve the subsequent page. When paginating, all other parameters
# provided to ListZoneActions must match the call that provided the page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListActionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListActionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_lake_zone_actions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/actions', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListActionsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListActionsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates an asset resource.
# @param [String] parent
# Required. The resource name of the parent zone: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id` /zones/`zone_id``
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Asset] google_cloud_dataplex_v1_asset_object
# @param [String] asset_id
# Required. Asset identifier. This ID will be used to generate names such as
# table names when publishing metadata to Hive Metastore and BigQuery. * Must
# contain only lowercase letters, numbers and hyphens. * Must start with a
# letter. * Must end with a number or a letter. * Must be between 1-63
# characters. * Must be unique within the zone.
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_location_lake_zone_asset(parent, google_cloud_dataplex_v1_asset_object = nil, asset_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/assets', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Asset::Representation
command.request_object = google_cloud_dataplex_v1_asset_object
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['assetId'] = asset_id unless asset_id.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an asset resource. The referenced storage resource is detached (
# default) or deleted based on the associated Lifecycle policy.
# @param [String] name
# Required. The resource name of the asset: projects/`project_number`/locations/`
# location_id`/lakes/`lake_id` /zones/`zone_id`/assets/`asset_id`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_location_lake_zone_asset(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves an asset resource.
# @param [String] name
# Required. The resource name of the asset: projects/`project_number`/locations/`
# location_id`/lakes/`lake_id` /zones/`zone_id`/assets/`asset_id`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Asset] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Asset]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_zone_asset(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Asset::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Asset
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The maximum policy version that will be used to format the policy.
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.Requests for policies with any conditional role bindings must specify
# version 3. Policies with no conditional role bindings may specify any valid
# value or leave the field unset.The policy in the response might use the policy
# version that you specified, or it might use a lower policy version. For
# example, if you specify version 3, but the policy has no conditional role
# bindings, the response uses version 1.To learn which resources support
# conditions in their IAM policies, see the IAM documentation (https://cloud.
# google.com/iam/help/conditions/resource-policies).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_zone_asset_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists asset resources in a zone.
# @param [String] parent
# Required. The resource name of the parent zone: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id` /zones/`zone_id``
# @param [String] filter
# Optional. Filter request.
# @param [String] order_by
# Optional. Order by fields for the result.
# @param [Fixnum] page_size
# Optional. Maximum number of asset to return. The service may return fewer than
# this value. If unspecified, at most 10 assets will be returned. The maximum
# value is 1000; values above 1000 will be coerced to 1000.
# @param [String] page_token
# Optional. Page token received from a previous ListAssets call. Provide this to
# retrieve the subsequent page. When paginating, all other parameters provided
# to ListAssets must match the call that provided the page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListAssetsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListAssetsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_lake_zone_assets(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/assets', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListAssetsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListAssetsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates an asset resource.
# @param [String] name
# Output only. The relative resource name of the asset, of the form: projects/`
# project_number`/locations/`location_id`/lakes/`lake_id`/zones/`zone_id`/assets/
# `asset_id`.
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Asset] google_cloud_dataplex_v1_asset_object
# @param [String] update_mask
# Required. Mask of fields to update.
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_location_lake_zone_asset(name, google_cloud_dataplex_v1_asset_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Asset::Representation
command.request_object = google_cloud_dataplex_v1_asset_object
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
# errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_project_location_lake_zone_asset_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest::Representation
command.request_object = google_iam_v1_set_iam_policy_request_object
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified resource. If the
# resource does not exist, this will return an empty set of permissions, not a
# NOT_FOUND error.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.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1_test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_project_location_lake_zone_asset_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest::Representation
command.request_object = google_iam_v1_test_iam_permissions_request_object
command.response_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists action resources in an asset.
# @param [String] parent
# Required. The resource name of the parent asset: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id`/zones/`zone_id`/assets/`asset_id`
# @param [Fixnum] page_size
# Optional. Maximum number of actions to return. The service may return fewer
# than this value. If unspecified, at most 10 actions will be returned. The
# maximum value is 1000; values above 1000 will be coerced to 1000.
# @param [String] page_token
# Optional. Page token received from a previous ListAssetActions call. Provide
# this to retrieve the subsequent page. When paginating, all other parameters
# provided to ListAssetActions must match the call that provided the page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListActionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListActionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_lake_zone_asset_actions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/actions', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListActionsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListActionsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Create a metadata entity.
# @param [String] parent
# Required. The resource name of the parent zone: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id`/zones/`zone_id`.
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity] google_cloud_dataplex_v1_entity_object
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_location_lake_zone_entity(parent, google_cloud_dataplex_v1_entity_object = nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/entities', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity::Representation
command.request_object = google_cloud_dataplex_v1_entity_object
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity
command.params['parent'] = parent unless parent.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete a metadata entity.
# @param [String] name
# Required. The resource name of the entity: projects/`project_number`/locations/
# `location_id`/lakes/`lake_id`/zones/`zone_id`/entities/`entity_id`.
# @param [String] etag
# Required. The etag associated with the entity, which can be retrieved with a
# GetEntity request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_location_lake_zone_entity(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::Empty::Representation
command.response_class = Google::Apis::DataplexV1::Empty
command.params['name'] = name unless name.nil?
command.query['etag'] = etag unless etag.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get a metadata entity.
# @param [String] name
# Required. The resource name of the entity: projects/`project_number`/locations/
# `location_id`/lakes/`lake_id`/zones/`zone_id`/entities/`entity_id`.
# @param [String] view
# Optional. Used to select the subset of entity information to return. Defaults
# to BASIC.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_zone_entity(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity
command.params['name'] = name unless name.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# List metadata entities in a zone.
# @param [String] parent
# Required. The resource name of the parent zone: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id`/zones/`zone_id`.
# @param [String] filter
# Optional. The following filter parameters can be added to the URL to limit the
# entities returned by the API: Entity ID: ?filter="id=entityID" Asset ID: ?
# filter="asset=assetID" Data path ?filter="data_path=gs://my-bucket" Is HIVE
# compatible: ?filter="hive_compatible=true" Is BigQuery compatible: ?filter="
# bigquery_compatible=true"
# @param [Fixnum] page_size
# Optional. Maximum number of entities to return. The service may return fewer
# than this value. If unspecified, 100 entities will be returned by default. The
# maximum value is 500; larger values will will be truncated to 500.
# @param [String] page_token
# Optional. Page token received from a previous ListEntities call. Provide this
# to retrieve the subsequent page. When paginating, all other parameters
# provided to ListEntities must match the call that provided the page token.
# @param [String] view
# Required. Specify the entity view to make a partial list request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListEntitiesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListEntitiesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_lake_zone_entities(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/entities', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListEntitiesResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListEntitiesResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Update a metadata entity. Only supports full resource update.
# @param [String] name
# Output only. The resource name of the entity, of the form: projects/`
# project_number`/locations/`location_id`/lakes/`lake_id`/zones/`zone_id`/
# entities/`id`.
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity] google_cloud_dataplex_v1_entity_object
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project_location_lake_zone_entity(name, google_cloud_dataplex_v1_entity_object = nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity::Representation
command.request_object = google_cloud_dataplex_v1_entity_object
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Entity
command.params['name'] = name unless name.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Create a metadata partition.
# @param [String] parent
# Required. The resource name of the parent zone: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id`/zones/`zone_id`/entities/`entity_id`.
# @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Partition] google_cloud_dataplex_v1_partition_object
# @param [Boolean] validate_only
# Optional. Only validate the request, but do not perform mutations. The default
# is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Partition] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Partition]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_location_lake_zone_entity_partition(parent, google_cloud_dataplex_v1_partition_object = nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/partitions', options)
command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Partition::Representation
command.request_object = google_cloud_dataplex_v1_partition_object
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Partition::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Partition
command.params['parent'] = parent unless parent.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete a metadata partition.
# @param [String] name
# Required. The resource name of the partition. format: projects/`project_number`
# /locations/`location_id`/lakes/`lake_id`/zones/`zone_id`/entities/`entity_id`/
# partitions/`partition_value_path`. The `partition_value_path` segment consists
# of an ordered sequence of partition values separated by "/". All values must
# be provided.
# @param [String] etag
# Optional. The etag associated with the partition.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_location_lake_zone_entity_partition(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::Empty::Representation
command.response_class = Google::Apis::DataplexV1::Empty
command.params['name'] = name unless name.nil?
command.query['etag'] = etag unless etag.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get a metadata partition of an entity.
# @param [String] name
# Required. The resource name of the partition: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id`/zones/`zone_id`/entities/`entity_id`/
# partitions/`partition_value_path`. The `partition_value_path` segment consists
# of an ordered sequence of partition values separated by "/". All values must
# be provided.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1Partition] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Partition]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_lake_zone_entity_partition(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1Partition::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1Partition
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# List metadata partitions of an entity.
# @param [String] parent
# Required. The resource name of the parent entity: projects/`project_number`/
# locations/`location_id`/lakes/`lake_id`/zones/`zone_id`/entities/`entity_id`.
# @param [String] filter
# Optional. Filter the partitions returned to the caller using a key value pair
# expression. Supported operators and syntax: logic operators: AND, OR
# comparison operators: <, >, >=, <= ,=, != LIKE operators: The right hand of a
# LIKE operator supports "." and "*" for wildcard searches, for example "value1
# LIKE ".*oo.*" parenthetical grouping: ( )Sample filter expression: `?filter="
# key1 < value1 OR key2 > value2"Notes: Keys to the left of operators are case
# insensitive. Partition results are sorted first by creation time, then by
# lexicographic order. Up to 20 key value filter pairs are allowed, but due to
# performance considerations, only the first 10 will be used as a filter.
# @param [Fixnum] page_size
# Optional. Maximum number of partitions to return. The service may return fewer
# than this value. If unspecified, 100 partitions will be returned by default.
# The maximum page size is 500; larger values will will be truncated to 500.
# @param [String] page_token
# Optional. Page token received from a previous ListPartitions call. Provide
# this to retrieve the subsequent page. When paginating, all other parameters
# provided to ListPartitions must match the call that provided the page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListPartitionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListPartitionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_lake_zone_entity_partitions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/partitions', options)
command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListPartitionsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListPartitionsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Starts asynchronous cancellation on a long-running operation. The server makes
# a best effort to cancel the operation, but success is not guaranteed. If the
# server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
# Clients can use Operations.GetOperation or other methods to check whether the
# cancellation succeeded or whether the operation completed despite cancellation.
# On successful cancellation, the operation is not deleted; instead, it becomes
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
# corresponding to Code.CANCELLED.
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [Google::Apis::DataplexV1::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def cancel_project_location_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
command.request_representation = Google::Apis::DataplexV1::GoogleLongrunningCancelOperationRequest::Representation
command.request_object = google_longrunning_cancel_operation_request_object
command.response_representation = Google::Apis::DataplexV1::Empty::Representation
command.response_class = Google::Apis::DataplexV1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a long-running operation. This method indicates that the client is no
# longer interested in the operation result. It does not cancel the operation.
# If the server doesn't support this method, it returns google.rpc.Code.
# UNIMPLEMENTED.
# @param [String] name
# The name of the operation resource to be deleted.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::Empty::Representation
command.response_class = Google::Apis::DataplexV1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# 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.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists operations that match the specified filter in the request. If the server
# doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding
# allows API services to override the binding to use different resource name
# schemes, such as users/*/operations. To override the binding, API services can
# add a binding such as "/v1/`name=users/*`/operations" to their service
# configuration. For backwards compatibility, the default name includes the
# operations collection id, however overriding users must ensure the name
# binding is the parent resource, without the operations collection id.
# @param [String] name
# The name of the operation's parent resource.
# @param [String] filter
# The standard list filter.
# @param [Fixnum] page_size
# The standard list page size.
# @param [String] page_token
# The standard list page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningListOperationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataplexV1::GoogleLongrunningListOperationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}/operations', options)
command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningListOperationsResponse::Representation
command.response_class = Google::Apis::DataplexV1::GoogleLongrunningListOperationsResponse
command.params['name'] = name unless name.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end