GoogleApi.DataCatalog.V1.Api.Entries (google_api_data_catalog v0.32.2)
View SourceAPI calls for all endpoints tagged Entries
.
Summary
Functions
Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service.
Functions
@spec datacatalog_entries_lookup(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1Entry.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service.
Parameters
-
connection
(type:GoogleApi.DataCatalog.V1.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"). -
:fullyQualifiedName
(type:String.t
) - Fully Qualified Name (FQN) of the resource. FQNs take two forms: For non-regionalized resources:{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
For regionalized resources:{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
Example for a DPMS table:dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}
-
:linkedResource
(type:String.t
) - The full name of the Google Cloud Platform resource the Data Catalog entry represents. For more information, see [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). Full names are case-sensitive. For example://bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}
//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}
-
:location
(type:String.t
) - Location where the lookup should be performed. Required to lookup entry that is not a part ofDPMS
orDATAPLEX
integrated_system
using itsfully_qualified_name
. Ignored in other cases. -
:project
(type:String.t
) - Project where the lookup should be performed. Required to lookup entry that is not a part ofDPMS
orDATAPLEX
integrated_system
using itsfully_qualified_name
. Ignored in other cases. -
:sqlResource
(type:String.t
) - The SQL name of the entry. SQL names are case-sensitive. Examples:pubsub.topic.{PROJECT_ID}.{TOPIC_ID}
pubsub.topic.{PROJECT_ID}.
`{TOPIC.ID.SEPARATED.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}
Identifiers (`_ID`) should comply with the [Lexical structure in GoogleSQL] (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1Entry{}}
on success -
{:error, info}
on failure