GoogleApi.DataCatalog.V1beta1.Api.Entries (google_api_data_catalog v0.32.2)

View Source

API calls for all endpoints tagged Entries.

Summary

Functions

Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.

Functions

datacatalog_entries_lookup(connection, optional_params \\ [], opts \\ [])

@spec datacatalog_entries_lookup(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1Entry.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.

Parameters

  • connection (type: GoogleApi.DataCatalog.V1beta1.Connection.t) - Connection to server
  • 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").
    • :linkedResource (type: String.t) - The full name of the Google Cloud Platform resource the Data Catalog entry represents. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Full names are case-sensitive. Examples: //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId //pubsub.googleapis.com/projects/projectId/topics/topicId
    • :sqlResource (type: String.t) - The SQL name of the entry. SQL names are case-sensitive. Examples: pubsub.project_id.topic_id pubsub.project_id.`topic.id.with.dots` bigquery.table.project_id.dataset_id.table_id bigquery.dataset.project_id.dataset_id datacatalog.entry.project_id.location_id.entry_group_id.entry_id `_id`s should satisfy the GoogleSQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.
  • opts (type: keyword()) - Call options

Returns

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