Reference documentation and code samples for the Google Cloud Asset V1 Client class AssetServiceClient.
Service Description: Asset service definition.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Asset \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
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 |
↳ 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 |
↳ 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. |
analyzeIamPolicy
Analyzes IAM policies to answer which identities have what accesses on which resources.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::analyzeIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\AnalyzeIamPolicyRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Asset\V1\AnalyzeIamPolicyResponse |
analyzeIamPolicyLongrunning
Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination. For Cloud Storage destination, the output format is the JSON format that represents a AnalyzeIamPolicyResponse.
This method implements the google.longrunning.Operation, which allows you to track the operation status. We recommend intervals of at least 2 seconds with exponential backoff retry to poll the operation result. The metadata contains the metadata for the long-running operation.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::analyzeIamPolicyLongrunningAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\AnalyzeIamPolicyLongrunningRequest
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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
analyzeMove
Analyze moving a resource to a specified destination without kicking off the actual move. The analysis is best effort depending on the user's permissions of viewing different hierarchical policies and configurations.
The policies and configuration are subject to change before the actual resource migration takes place.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::analyzeMoveAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\AnalyzeMoveRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Asset\V1\AnalyzeMoveResponse |
analyzeOrgPolicies
Analyzes organization policies under a scope.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::analyzeOrgPoliciesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\AnalyzeOrgPoliciesRequest
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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
analyzeOrgPolicyGovernedAssets
Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope. This RPC supports custom constraints and the following 10 canned constraints:
- storage.uniformBucketLevelAccess
- iam.disableServiceAccountKeyCreation
- iam.allowedPolicyMemberDomains
- compute.vmExternalIpAccess
- appengine.enforceServiceAccountActAsCheck
- gcp.resourceLocations
- compute.trustedImageProjects
- compute.skipDefaultNetworkCreation
- compute.requireOsLogin
- compute.disableNestedVirtualization
This RPC only returns either resources of types supported by searchable asset types, or IAM policies.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::analyzeOrgPolicyGovernedAssetsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\AnalyzeOrgPolicyGovernedAssetsRequest
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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
analyzeOrgPolicyGovernedContainers
Analyzes organization policies governed containers (projects, folders or organization) under a scope.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::analyzeOrgPolicyGovernedContainersAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\AnalyzeOrgPolicyGovernedContainersRequest
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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
batchGetAssetsHistory
Batch gets the update history of assets that overlap a time window.
For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::batchGetAssetsHistoryAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\BatchGetAssetsHistoryRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Asset\V1\BatchGetAssetsHistoryResponse |
batchGetEffectiveIamPolicies
Gets effective IAM policies for a batch of resources.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::batchGetEffectiveIamPoliciesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\BatchGetEffectiveIamPoliciesRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Asset\V1\BatchGetEffectiveIamPoliciesResponse |
createFeed
Creates a feed in a parent project/folder/organization to listen to its asset updates.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::createFeedAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\CreateFeedRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Asset\V1\Feed |
createSavedQuery
Creates a saved query in a parent project/folder/organization.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::createSavedQueryAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\CreateSavedQueryRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Asset\V1\SavedQuery |
deleteFeed
Deletes an asset feed.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::deleteFeedAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\DeleteFeedRequest
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. |
deleteSavedQuery
Deletes a saved query.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::deleteSavedQueryAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\DeleteSavedQueryRequest
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. |
exportAssets
Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a google.cloud.asset.v1.Asset in the JSON format; for BigQuery table destinations, the output table stores the fields in asset Protobuf as columns. This API implements the google.longrunning.Operation API, which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::exportAssetsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\ExportAssetsRequest
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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
getFeed
Gets details about an asset feed.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::getFeedAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\GetFeedRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Asset\V1\Feed |
getSavedQuery
Gets details about a saved query.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::getSavedQueryAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\GetSavedQueryRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Asset\V1\SavedQuery |
listAssets
Lists assets with time and resource types and returns paged results in response.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::listAssetsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\ListAssetsRequest
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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listFeeds
Lists all asset feeds in a parent project/folder/organization.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::listFeedsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\ListFeedsRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Asset\V1\ListFeedsResponse |
listSavedQueries
Lists all saved queries in a parent project/folder/organization.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::listSavedQueriesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\ListSavedQueriesRequest
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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
queryAssets
Issue a job that queries assets using a SQL statement compatible with BigQuery Standard SQL.
If the query execution finishes within timeout and there's no pagination,
the full query results will be returned in the QueryAssetsResponse
.
Otherwise, full query results can be obtained by issuing extra requests
with the job_reference
from the a previous QueryAssets
call.
Note, the query result has approximately 10 GB limitation enforced by BigQuery https://cloud.google.com/bigquery/docs/best-practices-performance-output, queries return larger results will result in errors.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::queryAssetsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\QueryAssetsRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Asset\V1\QueryAssetsResponse |
searchAllIamPolicies
Searches all IAM policies within the specified scope, such as a project,
folder, or organization. The caller must be granted the
cloudasset.assets.searchAllIamPolicies
permission on the desired scope,
otherwise the request will be rejected.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::searchAllIamPoliciesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\SearchAllIamPoliciesRequest
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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
searchAllResources
Searches all Google Cloud resources within the specified scope, such as a
project, folder, or organization. The caller must be granted the
cloudasset.assets.searchAllResources
permission on the desired scope,
otherwise the request will be rejected.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::searchAllResourcesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\SearchAllResourcesRequest
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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
updateFeed
Updates an asset feed configuration.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::updateFeedAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\UpdateFeedRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Asset\V1\Feed |
updateSavedQuery
Updates a saved query.
The async variant is Google\Cloud\Asset\V1\Client\BaseClient\self::updateSavedQueryAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\UpdateSavedQueryRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Asset\V1\SavedQuery |
analyzeIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\AnalyzeIamPolicyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
analyzeIamPolicyLongrunningAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\AnalyzeIamPolicyLongrunningRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
analyzeMoveAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\AnalyzeMoveRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
analyzeOrgPoliciesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\AnalyzeOrgPoliciesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
analyzeOrgPolicyGovernedAssetsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\AnalyzeOrgPolicyGovernedAssetsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
analyzeOrgPolicyGovernedContainersAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\AnalyzeOrgPolicyGovernedContainersRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
batchGetAssetsHistoryAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\BatchGetAssetsHistoryRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
batchGetEffectiveIamPoliciesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\BatchGetEffectiveIamPoliciesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createFeedAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\CreateFeedRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createSavedQueryAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\CreateSavedQueryRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteFeedAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\DeleteFeedRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteSavedQueryAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\DeleteSavedQueryRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
exportAssetsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\ExportAssetsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getFeedAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\GetFeedRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getSavedQueryAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\GetSavedQueryRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listAssetsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\ListAssetsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listFeedsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\ListFeedsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listSavedQueriesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\ListSavedQueriesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
queryAssetsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\QueryAssetsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
searchAllIamPoliciesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\SearchAllIamPoliciesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
searchAllResourcesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\SearchAllResourcesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateFeedAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\UpdateFeedRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateSavedQueryAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Asset\V1\UpdateSavedQueryRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\ApiCore\LongRunning\OperationsClient |
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.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
static::feedName
Formats a string containing the fully-qualified path to represent a feed resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
feed |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted feed resource. |
static::folderName
Formats a string containing the fully-qualified path to represent a folder resource.
Parameter | |
---|---|
Name | Description |
folder |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder resource. |
static::folderFeedName
Formats a string containing the fully-qualified path to represent a folder_feed resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
feed |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_feed resource. |
static::folderSavedQueryName
Formats a string containing the fully-qualified path to represent a folder_saved_query resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
savedQuery |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_saved_query resource. |
static::organizationName
Formats a string containing the fully-qualified path to represent a organization resource.
Parameter | |
---|---|
Name | Description |
organization |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization resource. |
static::organizationFeedName
Formats a string containing the fully-qualified path to represent a organization_feed resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
feed |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_feed resource. |
static::organizationSavedQueryName
Formats a string containing the fully-qualified path to represent a organization_saved_query resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
savedQuery |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_saved_query resource. |
static::projectName
Formats a string containing the fully-qualified path to represent a project resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project resource. |
static::projectFeedName
Formats a string containing the fully-qualified path to represent a project_feed resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
feed |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_feed resource. |
static::projectSavedQueryName
Formats a string containing the fully-qualified path to represent a project_saved_query resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
savedQuery |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_saved_query resource. |
static::savedQueryName
Formats a string containing the fully-qualified path to represent a saved_query resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
savedQuery |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted saved_query resource. |
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
- feed: projects/{project}/feeds/{feed}
- folder: folders/{folder}
- folderFeed: folders/{folder}/feeds/{feed}
- folderSavedQuery: folders/{folder}/savedQueries/{saved_query}
- organization: organizations/{organization}
- organizationFeed: organizations/{organization}/feeds/{feed}
- organizationSavedQuery: organizations/{organization}/savedQueries/{saved_query}
- project: projects/{project}
- projectFeed: projects/{project}/feeds/{feed}
- projectSavedQuery: projects/{project}/savedQueries/{saved_query}
- savedQuery: projects/{project}/savedQueries/{saved_query}
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.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array | An associative array from name component IDs to component values. |