google_api_data_catalog v0.6.0 GoogleApi.DataCatalog.V1beta1.Api.Projects View Source

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

Alpha feature. Creates an EntryGroup. The user should enable the Data Catalog API in the project identified by the parent parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Alpha feature. Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. The user should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Alpha feature. Creates an entry. Currently only entries of 'FILESET' type can be created. The user should enable the Data Catalog API in the project identified by the parent parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Alpha feature. Deletes an existing entry. Only entries created through CreateEntry method can be deleted. The user should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Gets the access control policy for a 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.

Updates an existing entry. The user should enable the Data Catalog API in the project identified by the entry.name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Creates a tag on an Entry. Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be from the same organization.

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a NOT_FOUND error).

Gets the access control policy for a 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.

Sets the access control policy for a resource. Replaces any existing policy. Supported resources are

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a NOT_FOUND error).

Creates a tag template. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Deletes a tag template and all tags using the template. The user should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Deletes a field in a tag template and all uses of that field. The user should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Updates a field in a tag template. This method cannot be used to update the field type. The user should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Gets the access control policy for a 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.

Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. The user should enable the Data Catalog API in the project identified by the tag_template.name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Sets the access control policy for a resource. Replaces any existing policy. Supported resources are

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a NOT_FOUND error).

Deletes a taxonomy. This operation will also delete all policy tags in this taxonomy along with their associated policies.

Lists all taxonomies in a project in a particular location that the caller has permission to view.

Link to this section Functions

Link to this function

datacatalog_projects_locations_entry_groups_create(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1EntryGroup.t()}
  | {:error, Tesla.Env.t()}

Alpha feature. Creates an EntryGroup. The user should enable the Data Catalog API in the project identified by the parent parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of parent. Required. The name of the project this entry group is in. Example:

    • projects/{project_id}/locations/{location}

    Note that this EntryGroup and its child resources may not actually be stored in the location in this name.

  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.

  • 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. The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.
    • :body (type: GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1EntryGroup.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1EntryGroup{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_delete(connection, projects_id, locations_id, entry_groups_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Empty.t()} | {:error, Tesla.Env.t()}

Alpha feature. Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. The user should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. The name of the entry group. For example, projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}.
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.
  • entry_groups_id (type: String.t) - Part of name. See documentation of projectsId.
  • 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 true, deletes all entries in the entry group.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_entries_create(connection, projects_id, locations_id, entry_groups_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_entries_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Entry.t()}
  | {:error, Tesla.Env.t()}

Alpha feature. Creates an entry. Currently only entries of 'FILESET' type can be created. The user should enable the Data Catalog API in the project identified by the parent parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of parent. Required. The name of the entry group this entry is in. Example:

    • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}

    Note that this Entry and its child resources may not actually be stored in the location in this name.

  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.

  • entry_groups_id (type: String.t) - Part of parent. See documentation of projectsId.

  • 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. The id of the entry to create.
    • :body (type: GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Entry.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Entry{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_entries_delete(connection, projects_id, locations_id, entry_groups_id, entries_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_entries_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Empty.t()} | {:error, Tesla.Env.t()}

Alpha feature. Deletes an existing entry. Only entries created through CreateEntry method can be deleted. The user should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of name. Required. The name of the entry. Example:

    • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.

  • entry_groups_id (type: String.t) - Part of name. See documentation of projectsId.

  • entries_id (type: String.t) - Part of name. See documentation of projectsId.

  • 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.DataCatalog.V1beta1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_entries_get(connection, projects_id, locations_id, entry_groups_id, entries_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_entries_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Entry.t()}
  | {:error, Tesla.Env.t()}

Gets an entry.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of name. Required. The name of the entry. Example:

    • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}

    Entry groups are logical groupings of entries. Currently, users cannot create/modify entry groups. They are created by Data Catalog; they include @bigquery for all BigQuery entries, and @pubsub for all Cloud Pub/Sub entries.

  • locations_id (type: String.t) - Part of name. See documentation of projectsId.

  • entry_groups_id (type: String.t) - Part of name. See documentation of projectsId.

  • entries_id (type: String.t) - Part of name. See documentation of projectsId.

  • 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.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Entry{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_entries_get_iam_policy(connection, projects_id, locations_id, entry_groups_id, entries_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_entries_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Policy.t()}
  | {:error, Tesla.Env.t()}

Gets the access control policy for a 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.

Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
  • datacatalog.entries.getIamPolicy to get policies on entries.
  • datacatalog.entryGroups.getIamPolicy to get policies on entry groups.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • entry_groups_id (type: String.t) - Part of resource. See documentation of projectsId.
  • entries_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.GetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_entries_patch(connection, projects_id, locations_id, entry_groups_id, entries_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_entries_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Entry.t()}
  | {:error, Tesla.Env.t()}

Updates an existing entry. The user should enable the Data Catalog API in the project identified by the entry.name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of entry.name. The Data Catalog resource name of the entry in URL format. Example:

    • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}

    Note that this Entry and its child resources may not actually be stored in the location in this name.

  • locations_id (type: String.t) - Part of entry.name. See documentation of projectsId.

  • entry_groups_id (type: String.t) - Part of entry.name. See documentation of projectsId.

  • entries_id (type: String.t) - Part of entry.name. See documentation of projectsId.

  • 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) - The fields to update on the entry. If absent or empty, all modifiable fields are updated.

      The following fields are modifiable:

      • For entries with type DATA_STREAM:

        • schema
      • For entries with type FILESET

        • schema
        • display_name
        • description
        • gcs_fileset_spec
        • gcs_fileset_spec.file_patterns
    • :body (type: GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Entry.t) -

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Entry{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_entries_tags_create(connection, projects_id, locations_id, entry_groups_id, entries_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_entries_tags_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Tag.t()}
  | {:error, Tesla.Env.t()}

Creates a tag on an Entry. Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be from the same organization.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of parent. Required. The name of the resource to attach this tag to. Tags can be attached to Entries. Example:

    • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}

    Note that this Tag and its child resources may not actually be stored in the location in this name.

  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.

  • entry_groups_id (type: String.t) - Part of parent. See documentation of projectsId.

  • entries_id (type: String.t) - Part of parent. See documentation of projectsId.

  • 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.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Tag.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Tag{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_entries_tags_delete(connection, projects_id, locations_id, entry_groups_id, entries_id, tags_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_entries_tags_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Empty.t()} | {:error, Tesla.Env.t()}

Deletes a tag.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of name. Required. The name of the tag to delete. Example:

    • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.

  • entry_groups_id (type: String.t) - Part of name. See documentation of projectsId.

  • entries_id (type: String.t) - Part of name. See documentation of projectsId.

  • tags_id (type: String.t) - Part of name. See documentation of projectsId.

  • 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.DataCatalog.V1beta1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_entries_tags_list(connection, projects_id, locations_id, entry_groups_id, entries_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_entries_tags_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1ListTagsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists the tags on an Entry.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry.
  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.
  • entry_groups_id (type: String.t) - Part of parent. See documentation of projectsId.
  • entries_id (type: String.t) - Part of parent. See documentation of projectsId.
  • 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()) - The maximum number of tags to return. Default is 10. Max limit is 1000.
    • :pageToken (type: String.t) - Token that specifies which page is requested. If empty, the first page is returned.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1ListTagsResponse{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_entries_tags_patch(connection, projects_id, locations_id, entry_groups_id, entries_id, tags_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_entries_tags_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Tag.t()}
  | {:error, Tesla.Env.t()}

Updates an existing tag.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of tag.name. The resource name of the tag in URL format. Example:

    • projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}

    where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.

  • locations_id (type: String.t) - Part of tag.name. See documentation of projectsId.

  • entry_groups_id (type: String.t) - Part of tag.name. See documentation of projectsId.

  • entries_id (type: String.t) - Part of tag.name. See documentation of projectsId.

  • tags_id (type: String.t) - Part of tag.name. See documentation of projectsId.

  • 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) - The fields to update on the Tag. If absent or empty, all modifiable fields are updated. Currently the only modifiable field is the field fields.
    • :body (type: GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Tag.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Tag{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_entries_test_iam_permissions(connection, projects_id, locations_id, entry_groups_id, entries_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_entries_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.TestIamPermissionsResponse.t()}
  | {:error, Tesla.Env.t()}

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a NOT_FOUND error).

Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.

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

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • entry_groups_id (type: String.t) - Part of resource. See documentation of projectsId.
  • entries_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.TestIamPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.TestIamPermissionsResponse{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_get(connection, projects_id, locations_id, entry_groups_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1EntryGroup.t()}
  | {:error, Tesla.Env.t()}

Alpha feature. Gets an EntryGroup.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. The name of the entry group. For example, projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}.
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.
  • entry_groups_id (type: String.t) - Part of name. See documentation of projectsId.
  • 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").
    • :readMask (type: String.t) - The fields to return. If not set or empty, all fields are returned.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1EntryGroup{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_get_iam_policy(connection, projects_id, locations_id, entry_groups_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Policy.t()}
  | {:error, Tesla.Env.t()}

Gets the access control policy for a 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.

Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
  • datacatalog.entries.getIamPolicy to get policies on entries.
  • datacatalog.entryGroups.getIamPolicy to get policies on entry groups.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • entry_groups_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.GetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_set_iam_policy(connection, projects_id, locations_id, entry_groups_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_set_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Policy.t()}
  | {:error, Tesla.Env.t()}

Sets the access control policy for a resource. Replaces any existing policy. Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
  • datacatalog.entries.setIamPolicy to set policies on entries.
  • datacatalog.entryGroups.setIamPolicy to set policies on entry groups.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • entry_groups_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.SetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_entry_groups_test_iam_permissions(connection, projects_id, locations_id, entry_groups_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_entry_groups_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.TestIamPermissionsResponse.t()}
  | {:error, Tesla.Env.t()}

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a NOT_FOUND error).

Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.

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

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • entry_groups_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.TestIamPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.TestIamPermissionsResponse{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_tag_templates_create(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_tag_templates_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplate.t()}
  | {:error, Tesla.Env.t()}

Creates a tag template. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of parent. Required. The name of the project and the location this template is in. Example:

    • projects/{project_id}/locations/{location}

    TagTemplate and its child resources may not actually be stored in the location in this name.

  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.

  • 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").
    • :tagTemplateId (type: String.t) - Required. The id of the tag template to create.
    • :body (type: GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplate.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplate{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_tag_templates_delete(connection, projects_id, locations_id, tag_templates_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_tag_templates_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Empty.t()} | {:error, Tesla.Env.t()}

Deletes a tag template and all tags using the template. The user should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of name. Required. The name of the tag template to delete. Example:

    • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.

  • tag_templates_id (type: String.t) - Part of name. See documentation of projectsId.

  • 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()) - Required. Currently, this field must always be set to true. This confirms the deletion of any possible tags using this template. force = false will be supported in the future.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_tag_templates_fields_create(connection, projects_id, locations_id, tag_templates_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_tag_templates_fields_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplateField.t()}
  | {:error, Tesla.Env.t()}

Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of parent. Required. The name of the project this template is in. Example:

    • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

    Note that this TagTemplateField may not actually be stored in the location in this name.

  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.

  • tag_templates_id (type: String.t) - Part of parent. See documentation of projectsId.

  • 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").
    • :tagTemplateFieldId (type: String.t) - Required. The ID of the tag template field to create. Field ids can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template.
    • :body (type: GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplateField.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplateField{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_tag_templates_fields_delete(connection, projects_id, locations_id, tag_templates_id, fields_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_tag_templates_fields_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Empty.t()} | {:error, Tesla.Env.t()}

Deletes a field in a tag template and all uses of that field. The user should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of name. Required. The name of the tag template field to delete. Example:

    • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.

  • tag_templates_id (type: String.t) - Part of name. See documentation of projectsId.

  • fields_id (type: String.t) - Part of name. See documentation of projectsId.

  • 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()) - Required. Currently, this field must always be set to true. This confirms the deletion of this field from any tags using this field. force = false will be supported in the future.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_tag_templates_fields_patch(connection, projects_id, locations_id, tag_templates_id, fields_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_tag_templates_fields_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplateField.t()}
  | {:error, Tesla.Env.t()}

Updates a field in a tag template. This method cannot be used to update the field type. The user should enable the Data Catalog API in the project identified by the name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of name. Required. The name of the tag template field. Example:

    • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.

  • tag_templates_id (type: String.t) - Part of name. See documentation of projectsId.

  • fields_id (type: String.t) - Part of name. See documentation of projectsId.

  • 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. The field mask specifies the parts of the template to be updated. Allowed fields:

      • display_name
      • type.enum_type
      • is_required

      If update_mask is not set or empty, all of the allowed fields above will be updated.

      When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed. Updating a template field from optional to required is NOT allowed.

    • :body (type: GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplateField.t) -

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplateField{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_tag_templates_fields_rename(connection, projects_id, locations_id, tag_templates_id, fields_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_tag_templates_fields_rename(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplateField.t()}
  | {:error, Tesla.Env.t()}

Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of name. Required. The name of the tag template. Example:

    • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.

  • tag_templates_id (type: String.t) - Part of name. See documentation of projectsId.

  • fields_id (type: String.t) - Part of name. See documentation of projectsId.

  • 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.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1RenameTagTemplateFieldRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplateField{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_tag_templates_get(connection, projects_id, locations_id, tag_templates_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_tag_templates_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplate.t()}
  | {:error, Tesla.Env.t()}

Gets a tag template.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of name. Required. The name of the tag template. Example:

    • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.

  • tag_templates_id (type: String.t) - Part of name. See documentation of projectsId.

  • 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.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplate{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_tag_templates_get_iam_policy(connection, projects_id, locations_id, tag_templates_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_tag_templates_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Policy.t()}
  | {:error, Tesla.Env.t()}

Gets the access control policy for a 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.

Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
  • datacatalog.entries.getIamPolicy to get policies on entries.
  • datacatalog.entryGroups.getIamPolicy to get policies on entry groups.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • tag_templates_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.GetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_tag_templates_patch(connection, projects_id, locations_id, tag_templates_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_tag_templates_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplate.t()}
  | {:error, Tesla.Env.t()}

Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. The user should enable the Data Catalog API in the project identified by the tag_template.name parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of tagTemplate.name. The resource name of the tag template in URL format. Example:

    • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

    Note that this TagTemplate and its child resources may not actually be stored in the location in this name.

  • locations_id (type: String.t) - Part of tagTemplate.name. See documentation of projectsId.

  • tag_templates_id (type: String.t) - Part of tagTemplate.name. See documentation of projectsId.

  • 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) - The field mask specifies the parts of the template to overwrite.

      Allowed fields:

      • display_name

      If absent or empty, all of the allowed fields above will be updated.

    • :body (type: GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplate.t) -

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplate{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_tag_templates_set_iam_policy(connection, projects_id, locations_id, tag_templates_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_tag_templates_set_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Policy.t()}
  | {:error, Tesla.Env.t()}

Sets the access control policy for a resource. Replaces any existing policy. Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
  • datacatalog.entries.setIamPolicy to set policies on entries.
  • datacatalog.entryGroups.setIamPolicy to set policies on entry groups.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • tag_templates_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.SetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_tag_templates_test_iam_permissions(connection, projects_id, locations_id, tag_templates_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_tag_templates_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.TestIamPermissionsResponse.t()}
  | {:error, Tesla.Env.t()}

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a NOT_FOUND error).

Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.

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

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • tag_templates_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.TestIamPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.TestIamPermissionsResponse{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_create(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Taxonomy.t()}
  | {:error, Tesla.Env.t()}

Creates a taxonomy in the specified project.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Resource name of the project that the taxonomy will belong to.
  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Taxonomy.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Taxonomy{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_delete(connection, projects_id, locations_id, taxonomies_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Empty.t()} | {:error, Tesla.Env.t()}

Deletes a taxonomy. This operation will also delete all policy tags in this taxonomy along with their associated policies.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Resource name of the taxonomy to be deleted. All policy tags in this taxonomy will also be deleted.
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of name. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_export(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_export(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1ExportTaxonomiesResponse.t()}
  | {:error, Tesla.Env.t()}

Exports all taxonomies and their policy tags in a project.

This method generates SerializedTaxonomy protos with nested policy tags that can be used as an input for future ImportTaxonomies calls.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Resource name of the project that taxonomies to be exported will share.
  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.
  • 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").
    • :serializedTaxonomies (type: boolean()) - Export taxonomies as serialized taxonomies.
    • :taxonomies (type: list(String.t)) - Required. Resource names of the taxonomies to be exported.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1ExportTaxonomiesResponse{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_get(connection, projects_id, locations_id, taxonomies_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Taxonomy.t()}
  | {:error, Tesla.Env.t()}

Gets a taxonomy.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Resource name of the requested taxonomy.
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of name. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Taxonomy{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_get_iam_policy(connection, projects_id, locations_id, taxonomies_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Policy.t()}
  | {:error, Tesla.Env.t()}

Gets the IAM policy for a taxonomy or a policy tag.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.GetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_import(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_import(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1ImportTaxonomiesResponse.t()}
  | {:error, Tesla.Env.t()}

Imports all taxonomies and their policy tags to a project as new taxonomies.

This method provides a bulk taxonomy / policy tag creation using nested proto structure.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Resource name of project that the newly created taxonomies will belong to.
  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1ImportTaxonomiesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1ImportTaxonomiesResponse{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_list(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1ListTaxonomiesResponse.t()}
  | {:error, Tesla.Env.t()}

Lists all taxonomies in a project in a particular location that the caller has permission to view.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Resource name of the project to list the taxonomies of.
  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.
  • 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()) - The maximum number of items to return. Must be a value between 1 and 1000. If not set, defaults to 50.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous list request, if any. If not set, defaults to an empty string.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1ListTaxonomiesResponse{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_patch(connection, projects_id, locations_id, taxonomies_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Taxonomy.t()}
  | {:error, Tesla.Env.t()}

Updates a taxonomy.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of taxonomy.name. Output only. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}".
  • locations_id (type: String.t) - Part of taxonomy.name. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of taxonomy.name. See documentation of projectsId.
  • 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) - The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.
    • :body (type: GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Taxonomy.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Taxonomy{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_policy_tags_create(connection, projects_id, locations_id, taxonomies_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_policy_tags_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1PolicyTag.t()}
  | {:error, Tesla.Env.t()}

Creates a policy tag in the specified taxonomy.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Resource name of the taxonomy that the policy tag will belong to.
  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of parent. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1PolicyTag.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1PolicyTag{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_policy_tags_delete(connection, projects_id, locations_id, taxonomies_id, policy_tags_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_policy_tags_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Empty.t()} | {:error, Tesla.Env.t()}

Deletes a policy tag. Also deletes all of its descendant policy tags.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Resource name of the policy tag to be deleted. All of its descendant policy tags will also be deleted.
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of name. See documentation of projectsId.
  • policy_tags_id (type: String.t) - Part of name. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_policy_tags_get(connection, projects_id, locations_id, taxonomies_id, policy_tags_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_policy_tags_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1PolicyTag.t()}
  | {:error, Tesla.Env.t()}

Gets a policy tag.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Resource name of the requested policy tag.
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of name. See documentation of projectsId.
  • policy_tags_id (type: String.t) - Part of name. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1PolicyTag{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_policy_tags_get_iam_policy(connection, projects_id, locations_id, taxonomies_id, policy_tags_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_policy_tags_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Policy.t()}
  | {:error, Tesla.Env.t()}

Gets the IAM policy for a taxonomy or a policy tag.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of resource. See documentation of projectsId.
  • policy_tags_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.GetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_policy_tags_list(connection, projects_id, locations_id, taxonomies_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_policy_tags_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1ListPolicyTagsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists all policy tags in a taxonomy.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Resource name of the taxonomy to list the policy tags of.
  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of parent. See documentation of projectsId.
  • 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()) - The maximum number of items to return. Must be a value between 1 and 1000. If not set, defaults to 50.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous List request, if any. If not set, defaults to an empty string.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1ListPolicyTagsResponse{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_policy_tags_patch(connection, projects_id, locations_id, taxonomies_id, policy_tags_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_policy_tags_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1PolicyTag.t()}
  | {:error, Tesla.Env.t()}

Updates a policy tag.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of policyTag.name. Output only. Resource name of this policy tag, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{id}".
  • locations_id (type: String.t) - Part of policyTag.name. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of policyTag.name. See documentation of projectsId.
  • policy_tags_id (type: String.t) - Part of policyTag.name. See documentation of projectsId.
  • 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) - The update mask applies to the resource. Only display_name, description and parent_policy_tag can be updated and thus can be listed in the mask. If update_mask is not provided, all allowed fields (i.e. display_name, description and parent) will be updated. For more information including the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.
    • :body (type: GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1PolicyTag.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1PolicyTag{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_policy_tags_set_iam_policy(connection, projects_id, locations_id, taxonomies_id, policy_tags_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_policy_tags_set_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Policy.t()}
  | {:error, Tesla.Env.t()}

Sets the IAM policy for a taxonomy or a policy tag.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of resource. See documentation of projectsId.
  • policy_tags_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.SetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_policy_tags_test_iam_permissions(connection, projects_id, locations_id, taxonomies_id, policy_tags_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_policy_tags_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.TestIamPermissionsResponse.t()}
  | {:error, Tesla.Env.t()}

Returns the permissions that a caller has on the specified taxonomy or policy tag.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of resource. See documentation of projectsId.
  • policy_tags_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.TestIamPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.TestIamPermissionsResponse{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_set_iam_policy(connection, projects_id, locations_id, taxonomies_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_set_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.Policy.t()}
  | {:error, Tesla.Env.t()}

Sets the IAM policy for a taxonomy or a policy tag.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.SetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure
Link to this function

datacatalog_projects_locations_taxonomies_test_iam_permissions(connection, projects_id, locations_id, taxonomies_id, optional_params \\ [], opts \\ [])

View Source
datacatalog_projects_locations_taxonomies_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataCatalog.V1beta1.Model.TestIamPermissionsResponse.t()}
  | {:error, Tesla.Env.t()}

Returns the permissions that a caller has on the specified taxonomy or policy tag.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (type: String.t) - Part of resource. See documentation of projectsId.
  • taxonomies_id (type: String.t) - Part of resource. See documentation of projectsId.
  • 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.DataCatalog.V1beta1.Model.TestIamPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataCatalog.V1beta1.Model.TestIamPermissionsResponse{}} on success
  • {:error, info} on failure