| Server IP : 66.29.137.217 / Your IP : 3.133.122.83 Web Server : LiteSpeed System : Linux premium294.web-hosting.com 4.18.0-513.11.1.lve.el8.x86_64 #1 SMP Thu Jan 18 16:21:02 UTC 2024 x86_64 User : gltevjme ( 1095) PHP Version : 7.0.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /home/gltevjme/bofirmacademy.com/vendor/google/apiclient-services/src/CloudAsset/Resource/ |
Upload File : |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\CloudAsset\Resource;
use Google\Service\CloudAsset\AnalyzeIamPolicyLongrunningRequest;
use Google\Service\CloudAsset\AnalyzeIamPolicyResponse;
use Google\Service\CloudAsset\AnalyzeMoveResponse;
use Google\Service\CloudAsset\AnalyzeOrgPoliciesResponse;
use Google\Service\CloudAsset\AnalyzeOrgPolicyGovernedAssetsResponse;
use Google\Service\CloudAsset\AnalyzeOrgPolicyGovernedContainersResponse;
use Google\Service\CloudAsset\BatchGetAssetsHistoryResponse;
use Google\Service\CloudAsset\ExportAssetsRequest;
use Google\Service\CloudAsset\Operation;
use Google\Service\CloudAsset\QueryAssetsRequest;
use Google\Service\CloudAsset\QueryAssetsResponse;
use Google\Service\CloudAsset\SearchAllIamPoliciesResponse;
use Google\Service\CloudAsset\SearchAllResourcesResponse;
/**
* The "v1" collection of methods.
* Typical usage is:
* <code>
* $cloudassetService = new Google\Service\CloudAsset(...);
* $v1 = $cloudassetService->v1;
* </code>
*/
class V1 extends \Google\Service\Resource
{
/**
* Analyzes IAM policies to answer which identities have what accesses on which
* resources. (v1.analyzeIamPolicy)
*
* @param string $scope Required. The relative name of the root asset. Only
* resources and IAM policies within the scope will be analyzed. This can only
* be an organization number (such as "organizations/123"), a folder number
* (such as "folders/123"), a project ID (such as "projects/my-project-id"), or
* a project number (such as "projects/12345"). To know how to get organization
* id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-
* managing-organization#retrieving_your_organization_id). To know how to get
* folder or project id, visit [here ](https://cloud.google.com/resource-
* manager/docs/creating-managing-
* folders#viewing_or_listing_folders_and_projects).
* @param array $optParams Optional parameters.
*
* @opt_param string analysisQuery.accessSelector.permissions Optional. The
* permissions to appear in result.
* @opt_param string analysisQuery.accessSelector.roles Optional. The roles to
* appear in result.
* @opt_param string analysisQuery.conditionContext.accessTime The hypothetical
* access timestamp to evaluate IAM conditions. Note that this value must not be
* earlier than the current time; otherwise, an INVALID_ARGUMENT error will be
* returned.
* @opt_param string analysisQuery.identitySelector.identity Required. The
* identity appear in the form of principals in [IAM policy
* binding](https://cloud.google.com/iam/reference/rest/v1/Binding). The
* examples of supported forms are: "user:mike@example.com",
* "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-
* id@appspot.gserviceaccount.com". Notice that wildcard characters (such as *
* and ?) are not supported. You must give a specific identity.
* @opt_param bool analysisQuery.options.analyzeServiceAccountImpersonation
* Optional. If true, the response will include access analysis from identities
* to resources via service account impersonation. This is a very expensive
* operation, because many derived queries will be executed. We highly recommend
* you use AssetService.AnalyzeIamPolicyLongrunning RPC instead. For example, if
* the request analyzes for which resources user A has permission P, and there's
* an IAM policy states user A has iam.serviceAccounts.getAccessToken permission
* to a service account SA, and there's another IAM policy states service
* account SA has permission P to a Google Cloud folder F, then user A
* potentially has access to the Google Cloud folder F. And those advanced
* analysis results will be included in
* AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Another
* example, if the request analyzes for who has permission P to a Google Cloud
* folder F, and there's an IAM policy states user A has
* iam.serviceAccounts.actAs permission to a service account SA, and there's
* another IAM policy states service account SA has permission P to the Google
* Cloud folder F, then user A potentially has access to the Google Cloud folder
* F. And those advanced analysis results will be included in
* AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Only the
* following permissions are considered in this analysis: *
* `iam.serviceAccounts.actAs` * `iam.serviceAccounts.signBlob` *
* `iam.serviceAccounts.signJwt` * `iam.serviceAccounts.getAccessToken` *
* `iam.serviceAccounts.getOpenIdToken` *
* `iam.serviceAccounts.implicitDelegation` Default is false.
* @opt_param bool analysisQuery.options.expandGroups Optional. If true, the
* identities section of the result will expand any Google groups appearing in
* an IAM policy binding. If IamPolicyAnalysisQuery.identity_selector is
* specified, the identity in the result will be determined by the selector, and
* this flag is not allowed to set. If true, the default max expansion per group
* is 1000 for AssetService.AnalyzeIamPolicy][]. Default is false.
* @opt_param bool analysisQuery.options.expandResources Optional. If true and
* IamPolicyAnalysisQuery.resource_selector is not specified, the resource
* section of the result will expand any resource attached to an IAM policy to
* include resources lower in the resource hierarchy. For example, if the
* request analyzes for which resources user A has permission P, and the results
* include an IAM policy with P on a Google Cloud folder, the results will also
* include resources in that folder with permission P. If true and
* IamPolicyAnalysisQuery.resource_selector is specified, the resource section
* of the result will expand the specified resource to include resources lower
* in the resource hierarchy. Only project or lower resources are supported.
* Folder and organization resources cannot be used together with this option.
* For example, if the request analyzes for which users have permission P on a
* Google Cloud project with this option enabled, the results will include all
* users who have permission P on that project or any lower resource. If true,
* the default max expansion per resource is 1000 for
* AssetService.AnalyzeIamPolicy][] and 100000 for
* AssetService.AnalyzeIamPolicyLongrunning][]. Default is false.
* @opt_param bool analysisQuery.options.expandRoles Optional. If true, the
* access section of result will expand any roles appearing in IAM policy
* bindings to include their permissions. If
* IamPolicyAnalysisQuery.access_selector is specified, the access section of
* the result will be determined by the selector, and this flag is not allowed
* to set. Default is false.
* @opt_param bool analysisQuery.options.outputGroupEdges Optional. If true, the
* result will output the relevant membership relationships between groups and
* other groups, and between groups and principals. Default is false.
* @opt_param bool analysisQuery.options.outputResourceEdges Optional. If true,
* the result will output the relevant parent/child relationships between
* resources. Default is false.
* @opt_param string analysisQuery.resourceSelector.fullResourceName Required.
* The [full resource name] (https://cloud.google.com/asset-
* inventory/docs/resource-name-format) of a resource of [supported resource
* types](https://cloud.google.com/asset-inventory/docs/supported-asset-
* types#analyzable_asset_types).
* @opt_param string executionTimeout Optional. Amount of time executable has to
* complete. See JSON representation of
* [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json).
* If this field is set with a value less than the RPC deadline, and the
* execution of your query hasn't finished in the specified execution timeout,
* you will get a response with partial result. Otherwise, your query's
* execution will continue until the RPC deadline. If it's not finished until
* then, you will get a DEADLINE_EXCEEDED error. Default is empty.
* @opt_param string savedAnalysisQuery Optional. The name of a saved query,
* which must be in the format of: *
* projects/project_number/savedQueries/saved_query_id *
* folders/folder_number/savedQueries/saved_query_id *
* organizations/organization_number/savedQueries/saved_query_id If both
* `analysis_query` and `saved_analysis_query` are provided, they will be merged
* together with the `saved_analysis_query` as base and the `analysis_query` as
* overrides. For more details of the merge behavior, please refer to the
* [MergeFrom](https://developers.google.com/protocol-
* buffers/docs/reference/cpp/google.protobuf.message#Message.MergeFrom.details)
* page. Note that you cannot override primitive fields with default value, such
* as 0 or empty string, etc., because we use proto3, which doesn't support
* field presence yet.
* @return AnalyzeIamPolicyResponse
*/
public function analyzeIamPolicy($scope, $optParams = [])
{
$params = ['scope' => $scope];
$params = array_merge($params, $optParams);
return $this->call('analyzeIamPolicy', [$params], AnalyzeIamPolicyResponse::class);
}
/**
* 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. (v1.analyzeIamPolicyLongrunning)
*
* @param string $scope Required. The relative name of the root asset. Only
* resources and IAM policies within the scope will be analyzed. This can only
* be an organization number (such as "organizations/123"), a folder number
* (such as "folders/123"), a project ID (such as "projects/my-project-id"), or
* a project number (such as "projects/12345"). To know how to get organization
* id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-
* managing-organization#retrieving_your_organization_id). To know how to get
* folder or project id, visit [here ](https://cloud.google.com/resource-
* manager/docs/creating-managing-
* folders#viewing_or_listing_folders_and_projects).
* @param AnalyzeIamPolicyLongrunningRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
*/
public function analyzeIamPolicyLongrunning($scope, AnalyzeIamPolicyLongrunningRequest $postBody, $optParams = [])
{
$params = ['scope' => $scope, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('analyzeIamPolicyLongrunning', [$params], Operation::class);
}
/**
* 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. (v1.analyzeMove)
*
* @param string $resource Required. Name of the resource to perform the
* analysis against. Only Google Cloud projects are supported as of today.
* Hence, this can only be a project ID (such as "projects/my-project-id") or a
* project number (such as "projects/12345").
* @param array $optParams Optional parameters.
*
* @opt_param string destinationParent Required. Name of the Google Cloud folder
* or organization to reparent the target resource. The analysis will be
* performed against hypothetically moving the resource to this specified
* desitination parent. This can only be a folder number (such as "folders/123")
* or an organization number (such as "organizations/123").
* @opt_param string view Analysis view indicating what information should be
* included in the analysis response. If unspecified, the default view is FULL.
* @return AnalyzeMoveResponse
*/
public function analyzeMove($resource, $optParams = [])
{
$params = ['resource' => $resource];
$params = array_merge($params, $optParams);
return $this->call('analyzeMove', [$params], AnalyzeMoveResponse::class);
}
/**
* Analyzes organization policies under a scope. (v1.analyzeOrgPolicies)
*
* @param string $scope Required. The organization to scope the request. Only
* organization policies within the scope will be analyzed. *
* organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
* @param array $optParams Optional parameters.
*
* @opt_param string constraint Required. The name of the constraint to analyze
* organization policies for. The response only contains analyzed organization
* policies for the provided constraint.
* @opt_param string filter The expression to filter
* AnalyzeOrgPoliciesResponse.org_policy_results. The only supported field is
* `consolidated_policy.attached_resource`, and the only supported operator is
* `=`. Example: consolidated_policy.attached_resource="//cloudresourcemanager.g
* oogleapis.com/folders/001" will return the org policy results
* of"folders/001".
* @opt_param int pageSize The maximum number of items to return per page. If
* unspecified, AnalyzeOrgPoliciesResponse.org_policy_results will contain 20
* items with a maximum of 200.
* @opt_param string pageToken The pagination token to retrieve the next page.
* @return AnalyzeOrgPoliciesResponse
*/
public function analyzeOrgPolicies($scope, $optParams = [])
{
$params = ['scope' => $scope];
$params = array_merge($params, $optParams);
return $this->call('analyzeOrgPolicies', [$params], AnalyzeOrgPoliciesResponse::class);
}
/**
* 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](https://cloud.google.com/asset-
* inventory/docs/supported-asset-types#searchable_asset_types), or IAM
* policies. (v1.analyzeOrgPolicyGovernedAssets)
*
* @param string $scope Required. The organization to scope the request. Only
* organization policies within the scope will be analyzed. The output assets
* will also be limited to the ones governed by those in-scope organization
* policies. * organizations/{ORGANIZATION_NUMBER} (e.g.,
* "organizations/123456")
* @param array $optParams Optional parameters.
*
* @opt_param string constraint Required. The name of the constraint to analyze
* governed assets for. The analysis only contains analyzed organization
* policies for the provided constraint.
* @opt_param string filter The expression to filter the governed assets in
* result. The only supported fields for governed resources are
* `governed_resource.project` and `governed_resource.folders`. The only
* supported fields for governed iam policies are `governed_iam_policy.project`
* and `governed_iam_policy.folders`. The only supported operator is `=`.
* Example 1: governed_resource.project="projects/12345678" filter will return
* all governed resources under projects/12345678 including the project ifself,
* if applicable. Example 2: governed_iam_policy.folders="folders/12345678"
* filter will return all governed iam policies under folders/12345678, if
* applicable.
* @opt_param int pageSize The maximum number of items to return per page. If
* unspecified, AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets will
* contain 100 items with a maximum of 200.
* @opt_param string pageToken The pagination token to retrieve the next page.
* @return AnalyzeOrgPolicyGovernedAssetsResponse
*/
public function analyzeOrgPolicyGovernedAssets($scope, $optParams = [])
{
$params = ['scope' => $scope];
$params = array_merge($params, $optParams);
return $this->call('analyzeOrgPolicyGovernedAssets', [$params], AnalyzeOrgPolicyGovernedAssetsResponse::class);
}
/**
* Analyzes organization policies governed containers (projects, folders or
* organization) under a scope. (v1.analyzeOrgPolicyGovernedContainers)
*
* @param string $scope Required. The organization to scope the request. Only
* organization policies within the scope will be analyzed. The output
* containers will also be limited to the ones governed by those in-scope
* organization policies. * organizations/{ORGANIZATION_NUMBER} (e.g.,
* "organizations/123456")
* @param array $optParams Optional parameters.
*
* @opt_param string constraint Required. The name of the constraint to analyze
* governed containers for. The analysis only contains organization policies for
* the provided constraint.
* @opt_param string filter The expression to filter the governed containers in
* result. The only supported field is `parent`, and the only supported operator
* is `=`. Example: parent="//cloudresourcemanager.googleapis.com/folders/001"
* will return all containers under "folders/001".
* @opt_param int pageSize The maximum number of items to return per page. If
* unspecified, AnalyzeOrgPolicyGovernedContainersResponse.governed_containers
* will contain 100 items with a maximum of 200.
* @opt_param string pageToken The pagination token to retrieve the next page.
* @return AnalyzeOrgPolicyGovernedContainersResponse
*/
public function analyzeOrgPolicyGovernedContainers($scope, $optParams = [])
{
$params = ['scope' => $scope];
$params = array_merge($params, $optParams);
return $this->call('analyzeOrgPolicyGovernedContainers', [$params], AnalyzeOrgPolicyGovernedContainersResponse::class);
}
/**
* 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.
* (v1.batchGetAssetsHistory)
*
* @param string $parent 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").
* @param array $optParams Optional parameters.
*
* @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.
* @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 readTimeWindow.startTime Start time of the time window
* (exclusive).
* @opt_param string relationshipTypes Optional. A list of relationship types to
* output, for example: `INSTANCE_TO_INSTANCEGROUP`. This field should only be
* specified if content_type=RELATIONSHIP. * If specified: it outputs specified
* relationships' history on the [asset_names]. It returns an error if any of
* the [relationship_types] doesn't belong to the supported relationship types
* of the [asset_names] or if any of the [asset_names]'s types doesn't belong to
* the source types of the [relationship_types]. * Otherwise: it outputs the
* supported relationships' history on the [asset_names] or returns an error if
* any of the [asset_names]'s types has no relationship support. See
* [Introduction to Cloud Asset Inventory](https://cloud.google.com/asset-
* inventory/docs/overview) for all supported asset types and relationship
* types.
* @return BatchGetAssetsHistoryResponse
*/
public function batchGetAssetsHistory($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('batchGetAssetsHistory', [$params], BatchGetAssetsHistoryResponse::class);
}
/**
* 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. (v1.exportAssets)
*
* @param string $parent 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").
* @param ExportAssetsRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
*/
public function exportAssets($parent, ExportAssetsRequest $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('exportAssets', [$params], Operation::class);
}
/**
* Issue a job that queries assets using a SQL statement compatible with
* [BigQuery SQL](https://cloud.google.com/bigquery/docs/introduction-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.
* (v1.queryAssets)
*
* @param string $parent 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"). Only assets
* belonging to the `parent` will be returned.
* @param QueryAssetsRequest $postBody
* @param array $optParams Optional parameters.
* @return QueryAssetsResponse
*/
public function queryAssets($parent, QueryAssetsRequest $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('queryAssets', [$params], QueryAssetsResponse::class);
}
/**
* 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)
*
* @param string $scope 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`](https://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")
* @param array $optParams Optional parameters.
*
* @opt_param string assetTypes Optional. A list of asset types that the IAM
* policies are attached to. If empty, it will search the IAM policies that are
* attached to all the [searchable asset types](https://cloud.google.com/asset-
* inventory/docs/supported-asset-types#searchable_asset_types). Regular
* expressions are also supported. For example: * "compute.googleapis.com.*"
* snapshots IAM policies attached to asset type starts with
* "compute.googleapis.com". * ".*Instance" snapshots IAM policies attached to
* asset type ends with "Instance". * ".*Instance.*" snapshots IAM policies
* attached to asset type contains "Instance". See
* [RE2](https://github.com/google/re2/wiki/Syntax) for all supported regular
* expression syntax. If the regular expression does not match any supported
* asset type, an INVALID_ARGUMENT error will be 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: "assetType DESC, resource". Only
* singular primitive fields in the response are sortable: * resource *
* assetType * project All the other fields such as repeated fields (e.g.,
* `folders`) and non-primitive fields (e.g., `policy`) are not supported.
* @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 or
* a negative value, 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`. Note
* that the query string is compared against each IAM policy binding, including
* its principals, roles, and IAM conditions. The returned IAM policies will
* only contain the bindings that match your query. To learn more about the IAM
* policy structure, see the [IAM policy
* documentation](https://cloud.google.com/iam/help/allow-policies/structure).
* 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:comp*` to find IAM
* policy bindings that contain "comp" as a prefix of any word in the binding. *
* `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. * `policy.role.permissions:upd*` to find IAM policy bindings
* that specify a role containing "upd" as a prefix of any word in the role
* 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". *
* `resource=//cloudresourcemanager.googleapis.com/projects/myproject` to find
* IAM policy bindings that are set on the project named "myproject". *
* `Important` to find IAM policy bindings that contain "Important" as a word 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". * `roles:roles/compute.admin` to find IAM policy bindings that specify
* the Compute Admin role. * `memberTypes:user` to find IAM policy bindings that
* contain the principal type "user".
* @return SearchAllIamPoliciesResponse
*/
public function searchAllIamPolicies($scope, $optParams = [])
{
$params = ['scope' => $scope];
$params = array_merge($params, $optParams);
return $this->call('searchAllIamPolicies', [$params], SearchAllIamPoliciesResponse::class);
}
/**
* 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. (v1.searchAllResources)
*
* @param string $scope 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`](https://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")
* @param array $optParams Optional parameters.
*
* @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). Regular expressions are also supported. For
* example: * "compute.googleapis.com.*" snapshots resources whose asset type
* starts with "compute.googleapis.com". * ".*Instance" snapshots resources
* whose asset type ends with "Instance". * ".*Instance.*" snapshots resources
* whose asset type contains "Instance". See
* [RE2](https://github.com/google/re2/wiki/Syntax) for all supported regular
* expression syntax. If the regular expression does not match any supported
* asset type, an INVALID_ARGUMENT error will be 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 the
* following fields in the response are sortable: * name * assetType * project *
* displayName * description * location * createTime * updateTime * state *
* parentFullResourceName * parentAssetType
* @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 or
* a negative value, 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, 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.
* @opt_param string query Optional. The query statement. See [how to construct
* a query](https://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`.
* Examples: * `name:Important` to find Google Cloud resources whose name
* contains `Important` as a word. * `name=Important` to find the Google Cloud
* resource whose name is exactly `Important`. * `displayName:Impor*` to find
* Google Cloud resources whose display name contains `Impor` as a prefix of any
* word in the field. * `location:us-west*` to find Google Cloud resources whose
* location contains both `us` and `west` as prefixes. * `labels:prod` to find
* Google Cloud resources whose labels contain `prod` as a key or value. *
* `labels.env:prod` to find Google Cloud resources that have a label `env` and
* its value is `prod`. * `labels.env:*` to find Google Cloud resources that
* have a label `env`. * `tagKeys:env` to find Google Cloud resources that have
* directly attached tags where the
* [`TagKey`](https://cloud.google.com/resource-
* manager/reference/rest/v3/tagKeys#resource:-tagkey) .`namespacedName`
* contains `env`. * `tagValues:prod*` to find Google Cloud resources that have
* directly attached tags where the
* [`TagValue`](https://cloud.google.com/resource-
* manager/reference/rest/v3/tagValues#resource:-tagvalue) .`namespacedName`
* contains a word prefixed by `prod`. * `tagValueIds=tagValues/123` to find
* Google Cloud resources that have directly attached tags where the
* [`TagValue`](https://cloud.google.com/resource-
* manager/reference/rest/v3/tagValues#resource:-tagvalue) .`name` is exactly
* `tagValues/123`. * `effectiveTagKeys:env` to find Google Cloud resources that
* have directly attached or inherited tags where the
* [`TagKey`](https://cloud.google.com/resource-
* manager/reference/rest/v3/tagKeys#resource:-tagkey) .`namespacedName`
* contains `env`. * `effectiveTagValues:prod*` to find Google Cloud resources
* that have directly attached or inherited tags where the
* [`TagValue`](https://cloud.google.com/resource-
* manager/reference/rest/v3/tagValues#resource:-tagvalue) .`namespacedName`
* contains a word prefixed by `prod`. * `effectiveTagValueIds=tagValues/123` to
* find Google Cloud resources that have directly attached or inherited tags
* where the [`TagValue`](https://cloud.google.com/resource-
* manager/reference/rest/v3/tagValues#resource:-tagvalue) .`name` is exactly
* `tagValues/123`. * `kmsKey:key` to find Google Cloud resources encrypted with
* a customer-managed encryption key whose name contains `key` as a word. This
* field is deprecated. Please use the `kmsKeys` field to retrieve Cloud KMS key
* information. * `kmsKeys:key` to find Google Cloud resources encrypted with
* customer-managed encryption keys whose name contains the word `key`. *
* `relationships:instance-group-1` to find Google Cloud resources that have
* relationships with `instance-group-1` in the related resource name. *
* `relationships:INSTANCE_TO_INSTANCEGROUP` to find Compute Engine instances
* that have relationships of type `INSTANCE_TO_INSTANCEGROUP`. *
* `relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1` to find Compute
* Engine instances that have relationships with `instance-group-1` in the
* Compute Engine instance group resource name, for relationship type
* `INSTANCE_TO_INSTANCEGROUP`. * `state:ACTIVE` to find Google Cloud resources
* whose state contains `ACTIVE` as a word. * `NOT state:ACTIVE` to find Google
* Cloud resources whose state doesn't contain `ACTIVE` as a word. *
* `createTime<1609459200` to find Google Cloud resources that were created
* before `2021-01-01 00:00:00 UTC`. `1609459200` is the epoch timestamp of
* `2021-01-01 00:00:00 UTC` in seconds. * `updateTime>1609459200` to find
* Google Cloud resources that were updated after `2021-01-01 00:00:00 UTC`.
* `1609459200` is the epoch timestamp of `2021-01-01 00:00:00 UTC` in seconds.
* * `Important` to find Google Cloud resources that contain `Important` as a
* word in any of the searchable fields. * `Impor*` to find Google Cloud
* resources that contain `Impor` as a prefix of any word in any of the
* searchable fields. * `Important location:(us-west1 OR global)` to find Google
* 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 string readMask Optional. A comma-separated list of fields that
* you want returned in the results. The following fields are returned by
* default if not specified: * `name` * `assetType` * `project` * `folders` *
* `organization` * `displayName` * `description` * `location` * `labels` *
* `tags` * `effectiveTags` * `networkTags` * `kmsKeys` * `createTime` *
* `updateTime` * `state` * `additionalAttributes` * `parentFullResourceName` *
* `parentAssetType` Some fields of large size, such as `versionedResources`,
* `attachedResources`, `effectiveTags` etc., are not returned by default, but
* you can specify them in the `read_mask` parameter if you want to include
* them. If `"*"` is specified, all [available
* fields](https://cloud.google.com/asset-inventory/docs/reference/rest/v1/TopLe
* vel/searchAllResources#resourcesearchresult) are returned. Examples:
* `"name,location"`, `"name,versionedResources"`, `"*"`. Any invalid field path
* will trigger INVALID_ARGUMENT error.
* @return SearchAllResourcesResponse
*/
public function searchAllResources($scope, $optParams = [])
{
$params = ['scope' => $scope];
$params = array_merge($params, $optParams);
return $this->call('searchAllResources', [$params], SearchAllResourcesResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(V1::class, 'Google_Service_CloudAsset_Resource_V1');