Documentation

Google_Service_CloudAsset_Resource_V1 extends Google_Service_Resource
in package

The "v1" collection of methods.

Typical usage is: $cloudassetService = new Google_Service_CloudAsset(...); $v1 = $cloudassetService->v1;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
batchGetAssetsHistory()  : Google_Service_CloudAsset_BatchGetAssetsHistoryResponse
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.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
exportAssets()  : Google_Service_CloudAsset_Operation
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 proto as columns.
searchAllIamPolicies()  : Google_Service_CloudAsset_SearchAllIamPoliciesResponse
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. (v1.searchAllIamPolicies)
searchAllResources()  : Google_Service_CloudAsset_SearchAllResourcesResponse
Searches all 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. (v1.searchAllResources)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

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.

public batchGetAssetsHistory(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudAsset_BatchGetAssetsHistoryResponse

(v1.batchGetAssetsHistory)

Parameters
$parent : string

Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345").

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string readTimeWindow.startTime Start time of the time window (exclusive).

opt_param

string contentType Optional. The content type.

opt_param

string readTimeWindow.endTime End time of the time window (inclusive). If not specified, the current timestamp is used instead.

opt_param

string assetNames A list of the full names of the assets. See: https://cloud.google.com/asset-inventory/docs/resource-name-format Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instan ce1. The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request.

Return values
Google_Service_CloudAsset_BatchGetAssetsHistoryResponse

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

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 proto as columns.

public exportAssets(string $parent, Google_Service_CloudAsset_ExportAssetsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudAsset_Operation

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. (v1.exportAssets)

Parameters
$parent : string

Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"), or a folder number (such as "folders/123").

$postBody : Google_Service_CloudAsset_ExportAssetsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudAsset_Operation

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. (v1.searchAllIamPolicies)

public searchAllIamPolicies(string $scope[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudAsset_SearchAllIamPoliciesResponse
Parameters
$scope : string

Required. A scope can be a project, a folder, or an organization. The search is limited to the IAM policies within the scope. The caller must be granted the [cloudasset.assets.searchAllIamPolicies](http://cloud.google.com/asset- inventory/docs/access-control#required_permissions) permission on the desired scope. The allowed values are: * projects/{PROJECT_ID} (e.g., "projects/foo- bar") * projects/{PROJECT_NUMBER} (e.g., "projects/12345678") * folders/{FOLDER_NUMBER} (e.g., "folders/1234567") * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

opt_param

string pageToken Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters must be identical to those in the previous call.

opt_param

string query Optional. The query statement. See [how to construct a query](https://cloud.google.com/asset-inventory/docs/searching-iam- policies#how_to_construct_a_query) for more information. If not specified or empty, it will search all the IAM policies within the specified scope. Examples: * policy:amy@gmail.com to find IAM policy bindings that specify user "amy@gmail.com". * policy:roles/compute.admin to find IAM policy bindings that specify the Compute Admin role. * policy.role.permissions:storage.buckets.update to find IAM policy bindings that specify a role containing "storage.buckets.update" permission. Note that if callers don't have iam.roles.get access to a role's included permissions, policy bindings that specify this role will be dropped from the search results. * resource:organizations/123456 to find IAM policy bindings that are set on "organizations/123456". * Important to find IAM policy bindings that contain "Important" as a word in any of the searchable fields (except for the included permissions). * *por* to find IAM policy bindings that contain "por" as a substring in any of the searchable fields (except for the included permissions). * resource:(instance1 OR instance2) policy:amy to find IAM policy bindings that are set on resources "instance1" or "instance2" and also specify user "amy".

Return values
Google_Service_CloudAsset_SearchAllIamPoliciesResponse

searchAllResources()

Searches all 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. (v1.searchAllResources)

public searchAllResources(string $scope[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudAsset_SearchAllResourcesResponse
Parameters
$scope : string

Required. A scope can be a project, a folder, or an organization. The search is limited to the resources within the scope. The caller must be granted the [cloudasset.assets.searchAllResources](http://cloud.google.com/asset- inventory/docs/access-control#required_permissions) permission on the desired scope. The allowed values are: * projects/{PROJECT_ID} (e.g., "projects/foo- bar") * projects/{PROJECT_NUMBER} (e.g., "projects/12345678") * folders/{FOLDER_NUMBER} (e.g., "folders/1234567") * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string query Optional. The query statement. See [how to construct a query](http://cloud.google.com/asset-inventory/docs/searching- resources#how_to_construct_a_query) for more information. If not specified or empty, it will search all the resources within the specified scope. Note that the query string is compared against each Cloud IAM policy binding, including its members, roles, and Cloud IAM conditions. The returned Cloud IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see IAM policy doc. Examples: * name:Important to find Cloud resources whose name contains "Important" as a word. * displayName:Impor* to find Cloud resources whose display name contains "Impor" as a prefix. * description:*por* to find Cloud resources whose description contains "por" as a substring. * location:us-west* to find Cloud resources whose location is prefixed with "us-west". * labels:prod to find Cloud resources whose labels contain "prod" as a key or value. * labels.env:prod to find Cloud resources that have a label "env" and its value is "prod". * labels.env:* to find Cloud resources that have a label "env". * Important to find Cloud resources that contain "Important" as a word in any of the searchable fields. * Impor* to find Cloud resources that contain "Impor" as a prefix in any of the searchable fields. * *por* to find Cloud resources that contain "por" as a substring in any of the searchable fields. * Important location:(us-west1 OR global) to find Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location.

opt_param

int pageSize Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

opt_param

string orderBy Optional. A comma separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only string fields in the response are sortable, including name, displayName, description, location. All the other fields such as repeated fields (e.g., networkTags), map fields (e.g., labels) and struct fields (e.g., additionalAttributes) are not supported.

opt_param

string assetTypes Optional. A list of asset types that this request searches for. If empty, it will search all the [searchable asset types](https://cloud.google.com/asset-inventory/docs/supported-asset- types#searchable_asset_types).

opt_param

string pageToken Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters, must be identical to those in the previous call.

Return values
Google_Service_CloudAsset_SearchAllResourcesResponse

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results