com.google.cloud.asset.v1

Interface IamPolicySearchResultOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

IamPolicySearchResult, IamPolicySearchResult.Builder

public interface IamPolicySearchResultOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAssetType() The type of the resource associated with this IAM policy.
ByteString	getAssetTypeBytes() The type of the resource associated with this IAM policy.
IamPolicySearchResult.Explanation	getExplanation() Explanation about the IAM policy search result.
IamPolicySearchResult.ExplanationOrBuilder	getExplanationOrBuilder() Explanation about the IAM policy search result.
String	getFolders(int index) The folder(s) that the IAM policy belongs to, in the form of folders/{FOLDER_NUMBER}.
ByteString	getFoldersBytes(int index) The folder(s) that the IAM policy belongs to, in the form of folders/{FOLDER_NUMBER}.
int	getFoldersCount() The folder(s) that the IAM policy belongs to, in the form of folders/{FOLDER_NUMBER}.
List<String>	getFoldersList() The folder(s) that the IAM policy belongs to, in the form of folders/{FOLDER_NUMBER}.
String	getOrganization() The organization that the IAM policy belongs to, in the form of organizations/{ORGANIZATION_NUMBER}.
ByteString	getOrganizationBytes() The organization that the IAM policy belongs to, in the form of organizations/{ORGANIZATION_NUMBER}.
com.google.iam.v1.Policy	getPolicy() The IAM policy directly set on the given resource.
com.google.iam.v1.PolicyOrBuilder	getPolicyOrBuilder() The IAM policy directly set on the given resource.
String	getProject() The project that the associated GCP resource belongs to, in the form of projects/{PROJECT_NUMBER}.
ByteString	getProjectBytes() The project that the associated GCP resource belongs to, in the form of projects/{PROJECT_NUMBER}.
String	getResource() The full resource name of the resource associated with this IAM policy.
ByteString	getResourceBytes() The full resource name of the resource associated with this IAM policy.
boolean	hasExplanation() Explanation about the IAM policy search result.
boolean	hasPolicy() The IAM policy directly set on the given resource.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getResource

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](https://cloud.google.com/asset-inventory/docs/resource-name-format)
 for more information.
 To search against the `resource`:
 * use a field query. Example: `resource:organizations/123`
 

string resource = 1;

Returns:

The resource.

getResourceBytes

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](https://cloud.google.com/asset-inventory/docs/resource-name-format)
 for more information.
 To search against the `resource`:
 * use a field query. Example: `resource:organizations/123`
 

string resource = 1;

Returns:

The bytes for resource.

getAssetType

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:

The assetType.

getAssetTypeBytes

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:

The bytes for assetType.

getProject

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:

The project.

getProjectBytes

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:

The bytes for project.

getFoldersList

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:

A list containing the folders.

getFoldersCount

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:

The count of folders.

getFolders

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;

Parameters:

index - The index of the element to return.

Returns:

The folders at the given index.

getFoldersBytes

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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the folders at the given index.

getOrganization

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:

The organization.

getOrganizationBytes

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:

The bytes for organization.

hasPolicy

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:

Whether the policy field is set.

getPolicy

com.google.iam.v1.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:

The policy.

getPolicyOrBuilder

com.google.iam.v1.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;

hasExplanation

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:

Whether the explanation field is set.

getExplanation

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:

The explanation.

getExplanationOrBuilder

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;