Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class DataCatalogClient.
Service Description: Data Catalog API service allows you to discover, understand, and manage your data.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
This class is currently experimental and may be subject to changes. See Google\Cloud\DataCatalog\V1\DataCatalogClient for the stable implementation
Namespace
Google \ Cloud \ DataCatalog \ V1 \ ClientMethods
__construct
Constructor.
options
array
Optional. Options for configuring the service API wrapper.
↳ apiEndpoint
string
The address of the API remote host. May optionally include the port, formatted as "
↳ credentials
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage : In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to false
.
↳ clientConfig
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport
string|TransportInterface
The transport used for executing network requests. May be either the string rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
createEntry
Creates an entry.
You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.
You must enable the Data Catalog API in the project identified by
the parent
parameter. For more information, see Data Catalog resource
project
.
An entry group can have a maximum of 100,000 entries.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::createEntryAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
createEntryGroup
Creates an entry group.
An entry group contains logically related entries together with Cloud Identity and Access Management policies. These policies specify users who can create, edit, and view entries within entry groups.
Data Catalog automatically creates entry groups with names that start with
the @
symbol for the following resources:
- BigQuery entries (
@bigquery) - Pub/Sub topics (
@pubsub) - Dataproc Metastore services (
@dataproc_metastore_{SERVICE_NAME_HASH})
You can create your own entry groups for Cloud Storage fileset entries
and custom entries together with the corresponding IAM policies.
User-created entry groups can't contain the @
symbol, it is reserved
for automatically created groups.
Entry groups, like entries, can be searched.
A maximum of 10,000 entry groups may be created per organization across all locations.
You must enable the Data Catalog API in the project identified by
the parent
parameter. For more information, see Data Catalog resource
project
.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::createEntryGroupAsync() .
request
Google\Cloud\DataCatalog\V1\CreateEntryGroupRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
createTag
Creates a tag and assigns it to:
- An Entry
if the method name is
projects.locations.entryGroups.entries.tags.create. - Or EntryGroup
if the method
name is
projects.locations.entryGroups.tags.create.
Note: The project identified by the parent
parameter for the tag
and the tag template
used to create the tag must be in the same organization.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::createTagAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
createTagTemplate
Creates a tag template.
You must enable the Data Catalog API in the project identified by the parent
parameter.
For more information, see Data Catalog resource project
.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::createTagTemplateAsync() .
request
Google\Cloud\DataCatalog\V1\CreateTagTemplateRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
createTagTemplateField
Creates a field in a tag template.
You must enable the Data Catalog API in the project identified by
the parent
parameter. For more information, see Data Catalog resource
project
.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::createTagTemplateFieldAsync() .
request
Google\Cloud\DataCatalog\V1\CreateTagTemplateFieldRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteEntry
Deletes an existing entry.
You can delete only the entries created by the CreateEntry method.
You must enable the Data Catalog API in the project identified by
the name
parameter. For more information, see Data Catalog
resource
project
.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::deleteEntryAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteEntryGroup
Deletes an entry group.
You must enable the Data Catalog API in the project
identified by the name
parameter. For more information, see Data Catalog
resource
project
.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::deleteEntryGroupAsync() .
request
Google\Cloud\DataCatalog\V1\DeleteEntryGroupRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteTag
Deletes a tag.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::deleteTagAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteTagTemplate
Deletes a tag template and all tags that use it.
You must enable the Data Catalog API in the project identified by
the name
parameter. For more information, see Data Catalog resource
project
.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::deleteTagTemplateAsync() .
request
Google\Cloud\DataCatalog\V1\DeleteTagTemplateRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteTagTemplateField
Deletes a field in a tag template and all uses of this field from the tags based on this template.
You must enable the Data Catalog API in the project identified by
the name
parameter. For more information, see Data Catalog resource
project
.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::deleteTagTemplateFieldAsync() .
request
Google\Cloud\DataCatalog\V1\DeleteTagTemplateFieldRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getEntry
Gets an entry.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::getEntryAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getEntryGroup
Gets an entry group.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::getEntryGroupAsync() .
request
Google\Cloud\DataCatalog\V1\GetEntryGroupRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getIamPolicy
Gets the access control policy for a resource.
May return:
- A
NOT_FOUNDerror if the resource doesn't exist or you don't have the permission to view it. - An empty policy if the resource exists but doesn't have a set policy.
Supported resources are:
- Tag templates
- Entry groups
Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.
To call this method, you must have the following Google IAM permissions:
-
datacatalog.tagTemplates.getIamPolicyto get policies on tag templates. -
datacatalog.entryGroups.getIamPolicyto get policies on entry groups.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::getIamPolicyAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getTagTemplate
Gets a tag template.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::getTagTemplateAsync() .
request
Google\Cloud\DataCatalog\V1\GetTagTemplateRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
importEntries
Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog.
ImportEntries
accepts source data snapshots of a third-party system.
Snapshot should be delivered as a .wire or base65-encoded .txt file
containing a sequence of Protocol Buffer messages of DumpItem
type.
ImportEntries
returns a long-running operation
resource that can be queried with Operations.GetOperation
to return ImportEntriesMetadata
and an ImportEntriesResponse
message.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::importEntriesAsync() .
request
Google\Cloud\DataCatalog\V1\ImportEntriesRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listEntries
Lists entries.
Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog .
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::listEntriesAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listEntryGroups
Lists entry groups.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::listEntryGroupsAsync() .
request
Google\Cloud\DataCatalog\V1\ListEntryGroupsRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listTags
Lists tags assigned to an Entry .
The columns in the response are lowercased.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::listTagsAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
lookupEntry
Gets an entry by its target resource name.
The resource name comes from the source Google Cloud Platform service.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::lookupEntryAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
modifyEntryContacts
Modifies contacts, part of the business context of an Entry .
To call this method, you must have the datacatalog.entries.updateContacts
IAM permission on the corresponding project.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::modifyEntryContactsAsync() .
request
Google\Cloud\DataCatalog\V1\ModifyEntryContactsRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
modifyEntryOverview
Modifies entry overview, part of the business context of an Entry .
To call this method, you must have the datacatalog.entries.updateOverview
IAM permission on the corresponding project.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::modifyEntryOverviewAsync() .
request
Google\Cloud\DataCatalog\V1\ModifyEntryOverviewRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
reconcileTags
ReconcileTags
creates or updates a list of tags on the entry.
If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list.
ReconcileTags
returns a long-running operation
resource that can be queried with Operations.GetOperation
to return ReconcileTagsMetadata
and
a ReconcileTagsResponse
message.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::reconcileTagsAsync() .
request
Google\Cloud\DataCatalog\V1\ReconcileTagsRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
renameTagTemplateField
Renames a field in a tag template.
You must enable the Data Catalog API in the project identified by the name
parameter. For more information, see Data Catalog resource project
.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::renameTagTemplateFieldAsync() .
request
Google\Cloud\DataCatalog\V1\RenameTagTemplateFieldRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
renameTagTemplateFieldEnumValue
Renames an enum value in a tag template.
Within a single enum field, enum values must be unique.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::renameTagTemplateFieldEnumValueAsync() .
request
Google\Cloud\DataCatalog\V1\RenameTagTemplateFieldEnumValueRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
searchCatalog
Searches Data Catalog for multiple resources like entries and tags that match a query.
This is a Custom Method that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.
Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries.
For more information, see Data Catalog search syntax .
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::searchCatalogAsync() .
request
Google\Cloud\DataCatalog\V1\SearchCatalogRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setIamPolicy
Sets an access control policy for a resource. Replaces any existing policy.
Supported resources are:
- Tag templates
- Entry groups
Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog.
To call this method, you must have the following Google IAM permissions:
-
datacatalog.tagTemplates.setIamPolicyto set policies on tag templates. -
datacatalog.entryGroups.setIamPolicyto set policies on entry groups.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::setIamPolicyAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
starEntry
Marks an Entry as starred by the current user. Starring information is private to each user.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::starEntryAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
testIamPermissions
Gets your permissions on a resource.
Returns an empty set of permissions if the resource doesn't exist.
Supported resources are:
- Tag templates
- Entry groups
Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog.
No Google IAM permissions are required to call this method.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::testIamPermissionsAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
unstarEntry
Marks an Entry as NOT starred by the current user. Starring information is private to each user.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::unstarEntryAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateEntry
Updates an existing entry.
You must enable the Data Catalog API in the project identified by
the entry.name
parameter. For more information, see Data Catalog
resource
project
.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::updateEntryAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateEntryGroup
Updates an entry group.
You must enable the Data Catalog API in the project identified by
the entry_group.name
parameter. For more information, see Data Catalog
resource
project
.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::updateEntryGroupAsync() .
request
Google\Cloud\DataCatalog\V1\UpdateEntryGroupRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateTag
Updates an existing tag.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::updateTagAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateTagTemplate
Updates a tag template.
You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.
You must enable the Data Catalog API in the project identified by
the tag_template.name
parameter. For more information, see Data Catalog
resource
project
.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::updateTagTemplateAsync() .
request
Google\Cloud\DataCatalog\V1\UpdateTagTemplateRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateTagTemplateField
Updates a field in a tag template.
You can't update the field type with this method.
You must enable the Data Catalog API in the project
identified by the name
parameter. For more information, see Data Catalog
resource
project
.
The async variant is Google\Cloud\DataCatalog\V1\Client\DataCatalogClient::updateTagTemplateFieldAsync() .
request
Google\Cloud\DataCatalog\V1\UpdateTagTemplateFieldRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
createEntryAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createEntryGroupAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createTagAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createTagTemplateAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createTagTemplateFieldAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteEntryAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteEntryGroupAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteTagAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteTagTemplateAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteTagTemplateFieldAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getEntryAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getEntryGroupAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getIamPolicyAsync
GuzzleHttp\Promise\PromiseInterface
getTagTemplateAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
importEntriesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listEntriesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listEntryGroupsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listTagsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
lookupEntryAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
modifyEntryContactsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
modifyEntryOverviewAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
reconcileTagsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
renameTagTemplateFieldAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
renameTagTemplateFieldEnumValueAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
searchCatalogAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setIamPolicyAsync
GuzzleHttp\Promise\PromiseInterface
starEntryAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
testIamPermissionsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
unstarEntryAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateEntryAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateEntryGroupAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateTagAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateTagTemplateAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateTagTemplateFieldAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
static::entryName
Formats a string containing the fully-qualified path to represent a entry resource.
project
string
location
string
entryGroup
string
entry
string
string
static::entryGroupName
Formats a string containing the fully-qualified path to represent a entry_group resource.
project
string
location
string
entryGroup
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::tagName
Formats a string containing the fully-qualified path to represent a tag resource.
project
string
location
string
entryGroup
string
entry
string
tag
string
string
static::tagTemplateName
Formats a string containing the fully-qualified path to represent a tag_template resource.
project
string
location
string
tagTemplate
string
string
static::tagTemplateFieldName
Formats a string containing the fully-qualified path to represent a tag_template_field resource.
project
string
location
string
tagTemplate
string
field
string
string
static::tagTemplateFieldEnumValueName
Formats a string containing the fully-qualified path to represent a tag_template_field_enum_value resource.
project
string
location
string
tagTemplate
string
tagTemplateFieldId
string
enumValueDisplayName
string
string
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}
- entryGroup: projects/{project}/locations/{location}/entryGroups/{entry_group}
- location: projects/{project}/locations/{location}
- tag: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}/tags/{tag}
- tagTemplate: projects/{project}/locations/{location}/tagTemplates/{tag_template}
- tagTemplateField: projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{field}
- tagTemplateFieldEnumValue: projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
