Google Cloud Asset V1 Client - Class IamPolicyAnalysisQuery (1.9.2)

Reference documentation and code samples for the Google Cloud Asset V1 Client class IamPolicyAnalysisQuery.

IAM policy analysis query message.

Generated from protobuf message google.cloud.asset.v1.IamPolicyAnalysisQuery

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ scope string

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 . To know how to get folder or project id, visit here .

↳ resource_selector Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\ResourceSelector

Optional. Specifies a resource for analysis.

↳ identity_selector Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\IdentitySelector

Optional. Specifies an identity for analysis.

↳ access_selector Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\AccessSelector

Optional. Specifies roles or permissions for analysis. This is optional.

↳ options Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\Options

Optional. The query options.

↳ condition_context Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\ConditionContext

Optional. The hypothetical context for IAM conditions evaluation.

getScope

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 . To know how to get folder or project id, visit here .

Generated from protobuf field string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
string

setScope

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 . To know how to get folder or project id, visit here .

Generated from protobuf field string scope = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getResourceSelector

Optional. Specifies a resource for analysis.

Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisQuery.ResourceSelector resource_selector = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\ResourceSelector|null

hasResourceSelector

clearResourceSelector

setResourceSelector

Optional. Specifies a resource for analysis.

Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisQuery.ResourceSelector resource_selector = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\ResourceSelector
Returns
TypeDescription
$this

getIdentitySelector

Optional. Specifies an identity for analysis.

Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisQuery.IdentitySelector identity_selector = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\IdentitySelector|null

hasIdentitySelector

clearIdentitySelector

setIdentitySelector

Optional. Specifies an identity for analysis.

Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisQuery.IdentitySelector identity_selector = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\IdentitySelector
Returns
TypeDescription
$this

getAccessSelector

Optional. Specifies roles or permissions for analysis. This is optional.

Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisQuery.AccessSelector access_selector = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\AccessSelector|null

hasAccessSelector

clearAccessSelector

setAccessSelector

Optional. Specifies roles or permissions for analysis. This is optional.

Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisQuery.AccessSelector access_selector = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\AccessSelector
Returns
TypeDescription
$this

getOptions

Optional. The query options.

Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisQuery.Options options = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\Options|null

hasOptions

clearOptions

setOptions

Optional. The query options.

Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisQuery.Options options = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\Options
Returns
TypeDescription
$this

getConditionContext

Optional. The hypothetical context for IAM conditions evaluation.

Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisQuery.ConditionContext condition_context = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\ConditionContext|null

hasConditionContext

clearConditionContext

setConditionContext

Optional. The hypothetical context for IAM conditions evaluation.

Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisQuery.ConditionContext condition_context = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var Google\Cloud\Asset\V1\IamPolicyAnalysisQuery\ConditionContext
Returns
TypeDescription
$this