Interface IamPolicySearchResultOrBuilder (3.10.0) 

public interface IamPolicySearchResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAssetType()

public abstract String getAssetType()

The type of the resource associated with this IAM policy. Example: compute.googleapis.com/Disk. To search against the asset_type:

  • specify the asset_types field in your search request.

string asset_type = 5;

Returns
Type Description
String

The assetType.

getAssetTypeBytes()

public abstract ByteString getAssetTypeBytes()

The type of the resource associated with this IAM policy. Example: compute.googleapis.com/Disk. To search against the asset_type:

  • specify the asset_types field in your search request.

string asset_type = 5;

Returns
Type Description
ByteString

The bytes for assetType.

getExplanation()

public abstract IamPolicySearchResult.Explanation getExplanation()

Explanation about the IAM policy search result. It contains additional information to explain why the search result matches the query.

.google.cloud.asset.v1.IamPolicySearchResult.Explanation explanation = 4;

Returns
Type Description
IamPolicySearchResult.Explanation

The explanation.

getExplanationOrBuilder()

public abstract IamPolicySearchResult.ExplanationOrBuilder getExplanationOrBuilder()

Explanation about the IAM policy search result. It contains additional information to explain why the search result matches the query.

.google.cloud.asset.v1.IamPolicySearchResult.Explanation explanation = 4;

Returns
Type Description
IamPolicySearchResult.ExplanationOrBuilder

getFolders(int index)

public abstract String getFolders(int index)

The folder(s) that the IAM policy belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the IAM policy belongs to one or more folders. To search against folders:

  • use a field query. Example: folders:(123 OR 456)
  • use a free text query. Example: 123
  • specify the scope field as this folder in your search request.

repeated string folders = 6;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The folders at the given index.

getFoldersBytes(int index)

public abstract ByteString getFoldersBytes(int index)

The folder(s) that the IAM policy belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the IAM policy belongs to one or more folders. To search against folders:

  • use a field query. Example: folders:(123 OR 456)
  • use a free text query. Example: 123
  • specify the scope field as this folder in your search request.

repeated string folders = 6;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the folders at the given index.

getFoldersCount()

public abstract int getFoldersCount()

The folder(s) that the IAM policy belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the IAM policy belongs to one or more folders. To search against folders:

  • use a field query. Example: folders:(123 OR 456)
  • use a free text query. Example: 123
  • specify the scope field as this folder in your search request.

repeated string folders = 6;

Returns
Type Description
int

The count of folders.

getFoldersList()

public abstract List<String> getFoldersList()

The folder(s) that the IAM policy belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the IAM policy belongs to one or more folders. To search against folders:

  • use a field query. Example: folders:(123 OR 456)
  • use a free text query. Example: 123
  • specify the scope field as this folder in your search request.

repeated string folders = 6;

Returns
Type Description
List<String>

A list containing the folders.

getOrganization()

public abstract String getOrganization()

The organization that the IAM policy belongs to, in the form of organizations/{ORGANIZATION_NUMBER}. This field is available when the IAM policy belongs to an organization. To search against organization:

  • use a field query. Example: organization:123
  • use a free text query. Example: 123
  • specify the scope field as this organization in your search request.

string organization = 7;

Returns
Type Description
String

The organization.

getOrganizationBytes()

public abstract ByteString getOrganizationBytes()

The organization that the IAM policy belongs to, in the form of organizations/{ORGANIZATION_NUMBER}. This field is available when the IAM policy belongs to an organization. To search against organization:

  • use a field query. Example: organization:123
  • use a free text query. Example: 123
  • specify the scope field as this organization in your search request.

string organization = 7;

Returns
Type Description
ByteString

The bytes for organization.

getPolicy()

public abstract Policy getPolicy()

The IAM policy directly set on the given resource. Note that the original IAM policy can contain multiple bindings. This only contains the bindings that match the given query. For queries that don't contain a constrain on policies (e.g., an empty query), this contains all the bindings. To search against the policy bindings:

  • use a field query:
    • query by the policy contained members. Example: policy:amy@gmail.com
    • query by the policy contained roles. Example: policy:roles/compute.admin
    • query by the policy contained roles' included permissions. Example: policy.role.permissions:compute.instances.create

.google.iam.v1.Policy policy = 3;

Returns
Type Description
com.google.iam.v1.Policy

The policy.

getPolicyOrBuilder()

public abstract PolicyOrBuilder getPolicyOrBuilder()

The IAM policy directly set on the given resource. Note that the original IAM policy can contain multiple bindings. This only contains the bindings that match the given query. For queries that don't contain a constrain on policies (e.g., an empty query), this contains all the bindings. To search against the policy bindings:

  • use a field query:
    • query by the policy contained members. Example: policy:amy@gmail.com
    • query by the policy contained roles. Example: policy:roles/compute.admin
    • query by the policy contained roles' included permissions. Example: policy.role.permissions:compute.instances.create

.google.iam.v1.Policy policy = 3;

Returns
Type Description
com.google.iam.v1.PolicyOrBuilder

getProject()

public abstract String getProject()

The project that the associated GCP resource belongs to, in the form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, this field will be empty. To search against the project:

  • specify the scope field as this project in your search request.

string project = 2;

Returns
Type Description
String

The project.

getProjectBytes()

public abstract ByteString getProjectBytes()

The project that the associated GCP resource belongs to, in the form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, this field will be empty. To search against the project:

  • specify the scope field as this project in your search request.

string project = 2;

Returns
Type Description
ByteString

The bytes for project.

getResource()

public abstract String getResource()

The full resource name of the resource associated with this IAM policy. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See Cloud Asset Inventory Resource Name Format for more information. To search against the resource:

  • use a field query. Example: resource:organizations/123

string resource = 1;

Returns
Type Description
String

The resource.

getResourceBytes()

public abstract ByteString getResourceBytes()

The full resource name of the resource associated with this IAM policy. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See Cloud Asset Inventory Resource Name Format for more information. To search against the resource:

  • use a field query. Example: resource:organizations/123

string resource = 1;

Returns
Type Description
ByteString

The bytes for resource.

hasExplanation()

public abstract boolean hasExplanation()

Explanation about the IAM policy search result. It contains additional information to explain why the search result matches the query.

.google.cloud.asset.v1.IamPolicySearchResult.Explanation explanation = 4;

Returns
Type Description
boolean

Whether the explanation field is set.

hasPolicy()

public abstract boolean hasPolicy()

The IAM policy directly set on the given resource. Note that the original IAM policy can contain multiple bindings. This only contains the bindings that match the given query. For queries that don't contain a constrain on policies (e.g., an empty query), this contains all the bindings. To search against the policy bindings:

  • use a field query:
    • query by the policy contained members. Example: policy:amy@gmail.com
    • query by the policy contained roles. Example: policy:roles/compute.admin
    • query by the policy contained roles' included permissions. Example: policy.role.permissions:compute.instances.create

.google.iam.v1.Policy policy = 3;

Returns
Type Description
boolean

Whether the policy field is set.