GoogleApi.DataCatalog.V1.Api.Organizations (google_api_data_catalog v0.32.2)

View Source

API calls for all endpoints tagged Organizations.

Summary

Functions

datacatalog_organizations_locations_retrieve_config(connection, name, optional_params \\ [], opts \\ [])

Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.

datacatalog_organizations_locations_retrieve_effective_config(connection, name, optional_params \\ [], opts \\ [])

Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.

datacatalog_organizations_locations_set_config(connection, name, optional_params \\ [], opts \\ [])

Sets the configuration related to the migration to Dataplex for an organization or project.

Functions

datacatalog_organizations_locations_retrieve_config(connection, name, optional_params \\ [], opts \\ [])

@spec datacatalog_organizations_locations_retrieve_config(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1OrganizationConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The organization whose config is being retrieved.
  • 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.V1.Model.GoogleCloudDatacatalogV1OrganizationConfig{}} on success
  • {:error, info} on failure

datacatalog_organizations_locations_retrieve_effective_config(connection, name, optional_params \\ [], opts \\ [])

@spec datacatalog_organizations_locations_retrieve_effective_config(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1MigrationConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource whose effective config is being retrieved.
  • 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.V1.Model.GoogleCloudDatacatalogV1MigrationConfig{}} on success
  • {:error, info} on failure

datacatalog_organizations_locations_set_config(connection, name, optional_params \\ [], opts \\ [])

@spec datacatalog_organizations_locations_set_config(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1MigrationConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sets the configuration related to the migration to Dataplex for an organization or project.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The organization or project whose config is being specified.
  • 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.V1.Model.GoogleCloudDatacatalogV1SetConfigRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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