View Source GoogleApi.Dataplex.V1.Api.Projects (google_api_dataplex v0.20.0)
API calls for all endpoints tagged Projects.
Summary
Functions
Creates an AspectType.
dataplex_projects_locations_aspect_types_delete(connection, name, optional_params \\ [], opts \\ [])
Deletes an AspectType.
Gets an AspectType.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
dataplex_projects_locations_aspect_types_list(connection, parent, optional_params \\ [], opts \\ [])
Lists AspectType resources in a project and location.
Updates an AspectType.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
Create a DataAttributeBinding resource.
Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.
Retrieves a DataAttributeBinding resource.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists DataAttributeBinding resources in a project and location.
Updates a DataAttributeBinding resource.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
dataplex_projects_locations_data_scans_create(connection, parent, optional_params \\ [], opts \\ [])
Creates a DataScan resource.
Deletes a DataScan resource.
Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.
Gets a DataScan resource.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.
dataplex_projects_locations_data_scans_jobs_get(connection, name, optional_params \\ [], opts \\ [])
Gets a DataScanJob resource.
Lists DataScanJobs under the given DataScan.
Lists DataScans.
Updates a DataScan resource.
Runs an on-demand execution of a DataScan
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
Create a DataAttribute resource.
Deletes a Data Attribute resource.
Retrieves a Data Attribute resource.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists Data Attribute resources in a DataTaxonomy.
Updates a DataAttribute resource.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
Create a DataTaxonomy resource.
Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.
dataplex_projects_locations_data_taxonomies_get(connection, name, optional_params \\ [], opts \\ [])
Retrieves a DataTaxonomy resource.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists DataTaxonomy resources in a project and location.
Updates a DataTaxonomy resource.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
Creates an EntryGroup.
dataplex_projects_locations_entry_groups_delete(connection, name, optional_params \\ [], opts \\ [])
Deletes an EntryGroup.
Creates an Entry.
Deletes an Entry.
Gets an Entry.Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).
Lists Entries within an EntryGroup.
Updates an Entry.
Gets an EntryGroup.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
dataplex_projects_locations_entry_groups_list(connection, parent, optional_params \\ [], opts \\ [])
Lists EntryGroup resources in a project and location.
Updates an EntryGroup.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
Creates an EntryType.
Deletes an EntryType.
Gets an EntryType.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists EntryType resources in a project and location.
Updates an EntryType.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
Gets information about a location.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
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.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
Lists action resources in a lake.
Create a content.
Delete a content.
Get a content resource.
Gets the access control policy for a contentitem resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource.
List content.
dataplex_projects_locations_lakes_content_patch(connection, name, optional_params \\ [], opts \\ [])
Update a content. Only supports full resource update.
Sets the access control policy on the specified contentitem resource. Replaces any existing policy.Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource.
Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).A caller is not required to have Google IAM permission to make this request.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Create a content.
Delete a content.
Get a content resource.
Gets the access control policy for a contentitem resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource.
List content.
Update a content. Only supports full resource update.
Sets the access control policy on the specified contentitem resource. Replaces any existing policy.Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource.
Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).A caller is not required to have Google IAM permission to make this request.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Creates a lake resource.
Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.
Create an environment resource.
Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.
Get environment resource.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists environments under the given lake.
Update the environment resource.
Lists session resources in an environment.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
Retrieves a lake resource.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists lake resources in a project and location.
Updates a lake resource.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Creates a task resource within a lake.
Delete the task resource.
Get task resource.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Cancel jobs running for the task resource.
Get job resource.
Lists Jobs under the given task.
Lists tasks under the given lake.
Update the task resource.
Run an on demand execution of a Task.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
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.
Lists action resources in a zone.
Lists action resources in an asset.
Creates an asset resource.
Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.
Retrieves an asset resource.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists asset resources in a zone.
Updates an asset resource.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
Creates a zone resource within a lake.
Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.
Create a metadata entity.
Delete a metadata entity.
Get a metadata entity.
List metadata entities in a zone.
Create a metadata partition.
Delete a metadata partition.
Get a metadata partition of an entity.
List metadata partitions of an entity.
Update a metadata entity. Only supports full resource update.
Retrieves a zone resource.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists zone resources in a lake.
Updates a zone resource.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
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.
Lists information about the supported locations for this service.
Looks up a single Entry by name using the permission on the source system.Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).
Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.
Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.
Gets a metadata job.
Lists metadata jobs.
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.
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.
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.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
Searches for Entries matching the given query and scope.
Functions
dataplex_projects_locations_aspect_types_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_aspect_types_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an AspectType.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:aspectTypeId(type:String.t) - Required. AspectType identifier. -
:validateOnly(type:boolean()) - Optional. The service validates the request without performing any mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1AspectType.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_aspect_types_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_aspect_types_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes an AspectType.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:etag(type:String.t) - Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_aspect_types_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1AspectType.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets an AspectType.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1AspectType{}}on success -
{:error, info}on failure
dataplex_projects_locations_aspect_types_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_aspect_types_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_aspect_types_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_aspect_types_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListAspectTypesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists AspectType resources in a project and location.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"These restrictions can be conjoined with AND, OR, and NOT conjunctions. -
:orderBy(type:String.t) - Optional. Orders the result by name or create_time fields. If not specified, the ordering is undefined. -
:pageSize(type:integer()) - Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 AspectTypes. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken(type:String.t) - Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to ListAspectTypes must match the call that provided the page token.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListAspectTypesResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_aspect_types_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an AspectType.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1AspectType.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_aspect_types_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_aspect_types_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_aspect_types_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_aspect_types_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_attribute_bindings_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_attribute_bindings_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Create a DataAttributeBinding resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:dataAttributeBindingId(type:String.t) - Required. DataAttributeBinding 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 Location. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataAttributeBinding.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_attribute_bindings_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_attribute_bindings_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:etag(type:String.t) - Required. If the client provided etag value does not match the current etag value, the DeleteDataAttributeBindingRequest method returns an ABORTED error response. Etags must be used when calling the DeleteDataAttributeBinding.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_attribute_bindings_get(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_attribute_bindings_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataAttributeBinding.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a DataAttributeBinding resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataAttributeBinding{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_attribute_bindings_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_attribute_bindings_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_attribute_bindings_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_attribute_bindings_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListDataAttributeBindingsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists DataAttributeBinding resources in a project and location.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the Location: projects/{project_number}/locations/{location_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. Filter request. Filter using resource: filter=resource:"resource-name" Filter using attribute: filter=attributes:"attribute-name" Filter using attribute in paths list: filter=paths.attributes:"attribute-name" -
:orderBy(type:String.t) - Optional. Order by fields for the result. -
:pageSize(type:integer()) - Optional. Maximum number of DataAttributeBindings to return. The service may return fewer than this value. If unspecified, at most 10 DataAttributeBindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken(type:String.t) - Optional. Page token received from a previous ListDataAttributeBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributeBindings must match the call that provided the page token.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListDataAttributeBindingsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_attribute_bindings_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_attribute_bindings_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a DataAttributeBinding resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataAttributeBinding.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_attribute_bindings_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_attribute_bindings_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_attribute_bindings_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_attribute_bindings_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_scans_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_scans_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a DataScan resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent location: projects/{project}/locations/{location_id} where project refers to a project_id or project_number and location_id refers to a GCP region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:dataScanId(type:String.t) - Required. DataScan identifier. 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. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataScan.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_data_scans_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a DataScan resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where project refers to a project_id or project_number and location_id refers to a GCP region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:force(type:boolean()) - Optional. If set to true, any child resources of this data scan will also be deleted. (Otherwise, the request will only work if the data scan has no child resources.)
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_scans_generate_data_quality_rules(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_scans_generate_data_quality_rules( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1GenerateDataQualityRulesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling) -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1GenerateDataQualityRulesRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1GenerateDataQualityRulesResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_data_scans_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataScan.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a DataScan resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where project refers to a project_id or project_number and location_id refers to a GCP region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:view(type:String.t) - Optional. Select the DataScan view to return. Defaults to BASIC.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataScan{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_scans_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_scans_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_scans_jobs_generate_data_quality_rules(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_scans_jobs_generate_data_quality_rules( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1GenerateDataQualityRulesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling) -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1GenerateDataQualityRulesRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1GenerateDataQualityRulesResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_scans_jobs_get(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_scans_jobs_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataScanJob.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a DataScanJob resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the DataScanJob: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id} where project refers to a project_id or project_number and location_id refers to a GCP region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:view(type:String.t) - Optional. Select the DataScanJob view to return. Defaults to BASIC.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataScanJob{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_scans_jobs_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_scans_jobs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListDataScanJobsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists DataScanJobs under the given DataScan.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent environment: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where project refers to a project_id or project_number and location_id refers to a GCP region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. An expression for filtering the results of the ListDataScanJobs request.If unspecified, all datascan jobs will be returned. Multiple filters can be applied (with AND, OR logical operators). Filters are case-sensitive.Allowed fields are: start_time end_timestart_time and end_time expect RFC-3339 formatted strings (e.g. 2018-10-08T18:30:00-07:00).For instance, 'start_time > 2018-10-08T00:00:00.123456789Z AND end_time < 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between specified start and end times. -
:pageSize(type:integer()) - Optional. Maximum number of DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken(type:String.t) - Optional. Page token received from a previous ListDataScanJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScanJobs must match the call that provided the page token.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListDataScanJobsResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_data_scans_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListDataScansResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists DataScans.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent location: projects/{project}/locations/{location_id} where project refers to a project_id or project_number and location_id refers to a GCP region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. Filter request. -
:orderBy(type:String.t) - Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined. -
:pageSize(type:integer()) - Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 500 scans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken(type:String.t) - Optional. Page token received from a previous ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans must match the call that provided the page token.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListDataScansResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_data_scans_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a DataScan resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. Identifier. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Optional. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataScan.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_data_scans_run( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1RunDataScanResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Runs an on-demand execution of a DataScan
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the DataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}. where project refers to a project_id or project_number and location_id refers to a GCP region.Only OnDemand data scans are allowed. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1RunDataScanRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1RunDataScanResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_scans_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_scans_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_scans_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_scans_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_attributes_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_attributes_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Create a DataAttribute resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:dataAttributeId(type:String.t) - Required. DataAttribute 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 DataTaxonomy. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataAttribute.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_attributes_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_attributes_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a Data Attribute resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the DataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:etag(type:String.t) - Optional. If the client provided etag value does not match the current etag value, the DeleteDataAttribute method returns an ABORTED error response.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_attributes_get(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_attributes_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataAttribute.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a Data Attribute resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the dataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataAttribute{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_attributes_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_attributes_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_attributes_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_attributes_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListDataAttributesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists Data Attribute resources in a DataTaxonomy.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. Filter request. -
:orderBy(type:String.t) - Optional. Order by fields for the result. -
:pageSize(type:integer()) - Optional. Maximum number of DataAttributes to return. The service may return fewer than this value. If unspecified, at most 10 dataAttributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken(type:String.t) - Optional. Page token received from a previous ListDataAttributes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributes must match the call that provided the page token.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListDataAttributesResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_attributes_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_attributes_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a DataAttribute resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataAttribute.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_attributes_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_attributes_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_attributes_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_attributes_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Create a DataTaxonomy resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the data taxonomy location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:dataTaxonomyId(type:String.t) - Required. DataTaxonomy 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 Project. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataTaxonomy.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:etag(type:String.t) - Optional. If the client provided etag value does not match the current etag value,the DeleteDataTaxonomy method returns an ABORTED error.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_get(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataTaxonomy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a DataTaxonomy resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataTaxonomy{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListDataTaxonomiesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists DataTaxonomy resources in a project and location.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the DataTaxonomy location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. Filter request. -
:orderBy(type:String.t) - Optional. Order by fields for the result. -
:pageSize(type:integer()) - Optional. Maximum number of DataTaxonomies to return. The service may return fewer than this value. If unspecified, at most 10 DataTaxonomies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken(type:String.t) - Optional. Page token received from a previous ListDataTaxonomies call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataTaxonomies must match the call that provided the page token.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListDataTaxonomiesResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a DataTaxonomy resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataTaxonomy.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_data_taxonomies_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_data_taxonomies_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_groups_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_groups_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an EntryGroup.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the entryGroup, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:entryGroupId(type:String.t) - Required. EntryGroup identifier. -
:validateOnly(type:boolean()) - Optional. The service validates the request without performing any mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1EntryGroup.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_groups_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_groups_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes an EntryGroup.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:etag(type:String.t) - Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_groups_entries_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_groups_entries_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entry.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an Entry.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:entryId(type:String.t) - Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entry.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entry{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_groups_entries_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_groups_entries_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entry.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes an Entry.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entry{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_groups_entries_get(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_groups_entries_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entry.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets an Entry.Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:aspectTypes(type:list(String.t)) - Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view. -
:paths(type:list(String.t)) - Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view. -
:view(type:String.t) - Optional. View to control which parts of an entry the service should return.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entry{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_groups_entries_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_groups_entries_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListEntriesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists Entries within an EntryGroup.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. A filter on the entries to return. Filters are case-sensitive. You can filter the request by the following fields: entry_type entry_source.display_nameThe comparison operators are =, !=, <, >, <=, >=. The service compares strings according to lexical order.You can use the logical operators AND, OR, NOT in the filter.You can use Wildcard "", but for entry_type you need to provide the full project id or number.Example filter expressions: "entry_source.display_name=AnExampleDisplayName" "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" "entry_type=projects/example-project/locations/us/entryTypes/a OR entry_type=projects/another-project/locations/*" "NOT entry_source.display_name=AnotherExampleDisplayName" -
:pageSize(type:integer()) - Optional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100. -
:pageToken(type:String.t) - Optional. Page token received from a previous ListEntries call. Provide this to retrieve the subsequent page.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListEntriesResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_groups_entries_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_groups_entries_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entry.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an Entry.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing(type:boolean()) - Optional. If set to true and the entry doesn't exist, the service will create it. -
:aspectKeys(type:list(String.t)) - Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @ - matches aspects of the given type for all paths. @path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. -
:deleteMissingAspects(type:boolean()) - Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. -
:updateMask(type:String.t) - Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entry.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entry{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_entry_groups_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1EntryGroup.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets an EntryGroup.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1EntryGroup{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_groups_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_groups_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_groups_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_groups_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListEntryGroupsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists EntryGroup resources in a project and location.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the entryGroup location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. Filter request. -
:orderBy(type:String.t) - Optional. Order by fields for the result. -
:pageSize(type:integer()) - Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryGroups. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken(type:String.t) - Optional. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to ListEntryGroups must match the call that provided the page token.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListEntryGroupsResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_entry_groups_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an EntryGroup.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. The service validates the request, without performing any mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1EntryGroup.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_groups_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_groups_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_groups_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_groups_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_link_types_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_link_types_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_link_types_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_link_types_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_link_types_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_link_types_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_types_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_types_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an EntryType.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:entryTypeId(type:String.t) - Required. EntryType identifier. -
:validateOnly(type:boolean()) - Optional. The service validates the request without performing any mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1EntryType.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_entry_types_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes an EntryType.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:etag(type:String.t) - Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_entry_types_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1EntryType.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets an EntryType.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1EntryType{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_types_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_types_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_entry_types_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListEntryTypesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists EntryType resources in a project and location.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the EntryType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"These restrictions can be conjoined with AND, OR, and NOT conjunctions. -
:orderBy(type:String.t) - Optional. Orders the result by name or create_time fields. If not specified, the ordering is undefined. -
:pageSize(type:integer()) - Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryTypes. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken(type:String.t) - Optional. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provided to ListEntryTypes must match the call that provided the page token.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListEntryTypesResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_entry_types_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an EntryType.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. The service validates the request without performing any mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1EntryType.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_types_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_types_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_entry_types_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_entry_types_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudLocationLocation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets information about a location.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Resource name for the location. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudLocationLocation{}}on success -
{:error, info}on failure
dataplex_projects_locations_glossaries_categories_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_glossaries_categories_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_glossaries_categories_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_glossaries_categories_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_glossaries_categories_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_glossaries_categories_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_glossaries_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_glossaries_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_glossaries_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_glossaries_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_glossaries_terms_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_glossaries_terms_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_glossaries_terms_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_glossaries_terms_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_glossaries_terms_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_glossaries_terms_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_glossaries_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_glossaries_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_governance_rules_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_governance_rules_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_governance_rules_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_governance_rules_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_governance_rules_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_governance_rules_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_actions_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_actions_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListActionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists action resources in a lake.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize(type:integer()) - 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. -
:pageToken(type:String.t) - 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.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListActionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_content_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_content_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Create a content.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_content_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_content_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Delete a content.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.Empty{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_content_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Get a content resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:view(type:String.t) - Optional. Specify content view to make a partial request.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_content_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_content_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a contentitem resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_content_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_content_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListContentResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
List content.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - 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. -
:pageSize(type:integer()) - Optional. Maximum number of content to return. The service may return fewer than this value. If unspecified, at most 10 content will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken(type:String.t) - 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.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListContentResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_content_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_content_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Update a content. Only supports full resource update.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_content_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_content_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified contentitem resource. Replaces any existing policy.Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_content_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_content_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).A caller is not required to have Google IAM permission to make this request.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_contentitems_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_contentitems_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Create a content.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_contentitems_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_contentitems_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Delete a content.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.Empty{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_contentitems_get(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_contentitems_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Get a content resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:view(type:String.t) - Optional. Specify content view to make a partial request.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_contentitems_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_contentitems_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a contentitem resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_contentitems_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_contentitems_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListContentResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
List content.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - 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. -
:pageSize(type:integer()) - Optional. Maximum number of content to return. The service may return fewer than this value. If unspecified, at most 10 content will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken(type:String.t) - 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.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListContentResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_contentitems_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_contentitems_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Update a content. Only supports full resource update.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Content{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_contentitems_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_contentitems_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified contentitem resource. Replaces any existing policy.Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_contentitems_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_contentitems_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).A caller is not required to have Google IAM permission to make this request.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a lake resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - 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. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:lakeId(type:String.t) - 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. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Lake.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_environments_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_environments_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Create an environment resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:environmentId(type:String.t) - 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. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Environment.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_environments_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_environments_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_environments_get(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_environments_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Environment.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Get environment resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Environment{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_environments_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_environments_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_environments_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_environments_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListEnvironmentsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists environments under the given lake.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. Filter request. -
:orderBy(type:String.t) - Optional. Order by fields for the result. -
:pageSize(type:integer()) - 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. -
:pageToken(type:String.t) - 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.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListEnvironmentsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_environments_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_environments_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Update the environment resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Environment.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_environments_sessions_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_environments_sessions_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListSessionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists session resources in an environment.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). :filter(type:String.t) - Optional. Filter request. The following mode filter is supported to return only the sessions belonging to the requester when the mode is USER and return sessions of all the users when the mode is ADMIN. When no filter is sent default to USER mode. NOTE: When the mode is ADMIN, the requester should have dataplex.environments.listAllSessions permission to list all sessions, in absence of the permission, the request fails.mode = ADMIN | USER-
:pageSize(type:integer()) - 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. -
:pageToken(type:String.t) - 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.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListSessionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_environments_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_environments_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_environments_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_environments_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Lake.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a lake resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Lake{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListLakesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists lake resources in a project and location.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - 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. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. Filter request. -
:orderBy(type:String.t) - Optional. Order by fields for the result. -
:pageSize(type:integer()) - 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. -
:pageToken(type:String.t) - 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.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListLakesResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a lake resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Lake.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_tasks_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_tasks_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a task resource within a lake.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:taskId(type:String.t) - Required. Task identifier. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Task.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_tasks_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Delete the task resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_tasks_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Task.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Get task resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Task{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_tasks_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_tasks_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_tasks_jobs_cancel(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_tasks_jobs_cancel( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Cancel jobs running for the task resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}/job/{job_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1CancelJobRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.Empty{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_tasks_jobs_get(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_tasks_jobs_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Job.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Get job resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Job{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_tasks_jobs_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_tasks_jobs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListJobsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists Jobs under the given task.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize(type:integer()) - 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. -
:pageToken(type:String.t) - 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.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListJobsResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_tasks_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListTasksResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists tasks under the given lake.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. Filter request. -
:orderBy(type:String.t) - Optional. Order by fields for the result. -
:pageSize(type:integer()) - 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. -
:pageToken(type:String.t) - 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.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListTasksResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_tasks_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Update the task resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. The relative resource name of the task, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Task.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_tasks_run( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1RunTaskResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Run an on demand execution of a Task.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1RunTaskRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1RunTaskResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_tasks_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_tasks_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_tasks_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_tasks_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_actions_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_actions_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListActionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists action resources in a zone.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize(type:integer()) - 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. -
:pageToken(type:String.t) - 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.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListActionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_assets_actions_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_assets_actions_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListActionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists action resources in an asset.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize(type:integer()) - 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. -
:pageToken(type:String.t) - 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.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListActionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_assets_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_assets_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an asset resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:assetId(type:String.t) - 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. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Asset.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_assets_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_assets_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_assets_get(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_assets_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Asset.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves an asset resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Asset{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_assets_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_assets_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_assets_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_assets_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListAssetsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists asset resources in a zone.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. Filter request. -
:orderBy(type:String.t) - Optional. Order by fields for the result. -
:pageSize(type:integer()) - 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. -
:pageToken(type:String.t) - 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.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListAssetsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_assets_patch(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_assets_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an asset resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - 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}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Asset.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_assets_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_assets_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_assets_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_assets_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a zone resource within a lake.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:zoneId(type:String.t) - 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") -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Zone.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_zones_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_entities_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_entities_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entity.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Create a metadata entity.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entity.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entity{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_entities_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_entities_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Delete a metadata entity.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:etag(type:String.t) - Required. The etag associated with the entity, which can be retrieved with a GetEntity request.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.Empty{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_entities_get(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_entities_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entity.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Get a metadata entity.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:view(type:String.t) - Optional. Used to select the subset of entity information to return. Defaults to BASIC.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entity{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_entities_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_entities_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListEntitiesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
List metadata entities in a zone.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - 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" -
:pageSize(type:integer()) - 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. -
:pageToken(type:String.t) - 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. -
:view(type:String.t) - Required. Specify the entity view to make a partial list request.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListEntitiesResponse{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_entities_partitions_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_entities_partitions_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Partition.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Create a metadata partition.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Partition.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Partition{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_entities_partitions_delete(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_entities_partitions_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Delete a metadata partition.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - 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. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:etag(type:String.t) - Optional. The etag associated with the partition.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.Empty{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_entities_partitions_get(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_entities_partitions_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Partition.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Get a metadata partition of an entity.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - 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. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Partition{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_entities_partitions_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_entities_partitions_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListPartitionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
List metadata partitions of an entity.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - 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.:pageSize(type:integer()) - 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.:pageToken(type:String.t) - 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.opts(type:keyword()) - Call options ## Returns{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListPartitionsResponse{}}on success{:error, info}on failure
-
dataplex_projects_locations_lakes_zones_entities_update(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_entities_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entity.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Update a metadata entity. Only supports full resource update.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - 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}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entity.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entity{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_zones_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Zone.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a zone resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Zone{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"(type:integer()) - 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).
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_zones_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListZonesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists zone resources in a lake.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. Filter request. -
:orderBy(type:String.t) - Optional. Order by fields for the result. -
:pageSize(type:integer()) - 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. -
:pageToken(type:String.t) - 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.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListZonesResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lakes_zones_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a zone resource.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. Mask of fields to update. -
:validateOnly(type:boolean()) - Optional. Only validate the request, but do not perform mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Zone.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1SetIamPolicyRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1Policy{}}on success -
{:error, info}on failure
dataplex_projects_locations_lakes_zones_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_lakes_zones_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
resource(type:String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleIamV1TestIamPermissionsResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudLocationListLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists information about the supported locations for this service.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - The resource that owns the locations collection, if applicable. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - 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). -
:pageSize(type:integer()) - The maximum number of results to return. If not set, the service selects a default. -
:pageToken(type:String.t) - A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudLocationListLocationsResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_lookup_entry( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entry.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Looks up a single Entry by name using the permission on the source system.Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:aspectTypes(type:list(String.t)) - Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view. -
:entry(type:String.t) - Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. -
:paths(type:list(String.t)) - Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view. -
:view(type:String.t) - Optional. View to control which parts of an entry the service should return.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1Entry{}}on success -
{:error, info}on failure
dataplex_projects_locations_metadata_jobs_cancel(connection, name, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_metadata_jobs_cancel( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1CancelMetadataJobRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.Empty{}}on success -
{:error, info}on failure
dataplex_projects_locations_metadata_jobs_create(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_metadata_jobs_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:metadataJobId(type:String.t) - Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-. -
:validateOnly(type:boolean()) - Optional. The service validates the request without performing any mutations. The default is false. -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1MetadataJob.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_metadata_jobs_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1MetadataJob.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a metadata job.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The resource name of the metadata job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1MetadataJob{}}on success -
{:error, info}on failure
dataplex_projects_locations_metadata_jobs_list(connection, parent, optional_params \\ [], opts \\ [])
@spec dataplex_projects_locations_metadata_jobs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListMetadataJobsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists metadata jobs.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"You can combine filters with AND, OR, and NOT operators. -
:orderBy(type:String.t) - Optional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined. -
:pageSize(type:integer()) - Optional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000. -
:pageToken(type:String.t) - Optional. The page token received from a previous ListMetadataJobs call. Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataJobs request must match the call that provided the page token.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1ListMetadataJobsResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_operations_cancel( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - The name of the operation resource to be cancelled. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.Dataplex.V1.Model.GoogleLongrunningCancelOperationRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.Empty{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_operations_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - The name of the operation resource to be deleted. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.Empty{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - The name of the operation resource. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningOperation{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleLongrunningListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - The name of the operation's parent resource. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter(type:String.t) - The standard list filter. -
:pageSize(type:integer()) - The standard list page size. -
:pageToken(type:String.t) - The standard list page token.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleLongrunningListOperationsResponse{}}on success -
{:error, info}on failure
@spec dataplex_projects_locations_search_entries( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1SearchEntriesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Searches for Entries matching the given query and scope.
Parameters
-
connection(type:GoogleApi.Dataplex.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - 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. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - 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. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:orderBy(type:String.t) - Optional. Specifies the ordering of results. Supported values are: relevance (default) last_modified_timestamp * last_modified_timestamp asc -
:pageSize(type:integer()) - Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000. -
:pageToken(type:String.t) - Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page. -
:query(type:String.t) - Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog (https://cloud.google.com/dataplex/docs/search-syntax). -
:scope(type:String.t) - Optional. The scope under which the search should be operating. It must either be organizations/ or projects/. If it is unspecified, it defaults to the organization where the project provided in name is located.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1SearchEntriesResponse{}}on success -
{:error, info}on failure