source: vendor/google/apiclient-services/src/DataCatalog/Resource/Entries.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 6 weeks ago

Upload project files

  • Property mode set to 100644
File size: 3.6 KB
Line 
1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\DataCatalog\Resource;
19
20use Google\Service\DataCatalog\GoogleCloudDatacatalogV1Entry;
21
22/**
23 * The "entries" collection of methods.
24 * Typical usage is:
25 * <code>
26 * $datacatalogService = new Google\Service\DataCatalog(...);
27 * $entries = $datacatalogService->entries;
28 * </code>
29 */
30class Entries extends \Google\Service\Resource
31{
32 /**
33 * Gets an entry by its target resource name. The resource name comes from the
34 * source Google Cloud Platform service. (entries.lookup)
35 *
36 * @param array $optParams Optional parameters.
37 *
38 * @opt_param string fullyQualifiedName [Fully Qualified Name
39 * (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) of
40 * the resource. FQNs take two forms: * For non-regionalized resources:
41 * `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}` * For
42 * regionalized resources:
43 * `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
44 * Example for a DPMS table: `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INS
45 * TANCE_ID}.{DATABASE_ID}.{TABLE_ID}`
46 * @opt_param string linkedResource The full name of the Google Cloud Platform
47 * resource the Data Catalog entry represents. For more information, see [Full
48 * Resource Name]
49 * (https://cloud.google.com/apis/design/resource_names#full_resource_name).
50 * Full names are case-sensitive. For example: * `//bigquery.googleapis.com/proj
51 * ects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` *
52 * `//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}`
53 * @opt_param string location Location where the lookup should be performed.
54 * Required to lookup entry that is not a part of `DPMS` or `DATAPLEX`
55 * `integrated_system` using its `fully_qualified_name`. Ignored in other cases.
56 * @opt_param string project Project where the lookup should be performed.
57 * Required to lookup entry that is not a part of `DPMS` or `DATAPLEX`
58 * `integrated_system` using its `fully_qualified_name`. Ignored in other cases.
59 * @opt_param string sqlResource The SQL name of the entry. SQL names are case-
60 * sensitive. Examples: * `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}` *
61 * `pubsub.topic.{PROJECT_ID}.`\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\` *
62 * `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}` *
63 * `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}` *
64 * `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}`
65 * Identifiers (`*_ID`) should comply with the [Lexical structure in Standard
66 * SQL] (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
67 * @return GoogleCloudDatacatalogV1Entry
68 * @throws \Google\Service\Exception
69 */
70 public function lookup($optParams = [])
71 {
72 $params = [];
73 $params = array_merge($params, $optParams);
74 return $this->call('lookup', [$params], GoogleCloudDatacatalogV1Entry::class);
75 }
76}
77
78// Adding a class alias for backwards compatibility with the previous class name.
79class_alias(Entries::class, 'Google_Service_DataCatalog_Resource_Entries');
Note: See TracBrowser for help on using the repository browser.