public final class IamPolicySearchResult extends GeneratedMessageV3 implements IamPolicySearchResultOrBuilder
A result of IAM Policy search, containing information of an IAM policy.
Protobuf type google.cloud.asset.v1.IamPolicySearchResult
Static Fields
ASSET_TYPE_FIELD_NUMBER
public static final int ASSET_TYPE_FIELD_NUMBER
Field Value
EXPLANATION_FIELD_NUMBER
public static final int EXPLANATION_FIELD_NUMBER
Field Value
FOLDERS_FIELD_NUMBER
public static final int FOLDERS_FIELD_NUMBER
Field Value
ORGANIZATION_FIELD_NUMBER
public static final int ORGANIZATION_FIELD_NUMBER
Field Value
POLICY_FIELD_NUMBER
public static final int POLICY_FIELD_NUMBER
Field Value
PROJECT_FIELD_NUMBER
public static final int PROJECT_FIELD_NUMBER
Field Value
RESOURCE_FIELD_NUMBER
public static final int RESOURCE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static IamPolicySearchResult getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static IamPolicySearchResult.Builder newBuilder()
Returns
newBuilder(IamPolicySearchResult prototype)
public static IamPolicySearchResult.Builder newBuilder(IamPolicySearchResult prototype)
Parameter
Returns
public static IamPolicySearchResult parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static IamPolicySearchResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static IamPolicySearchResult parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static IamPolicySearchResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static IamPolicySearchResult parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static IamPolicySearchResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static IamPolicySearchResult parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static IamPolicySearchResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static IamPolicySearchResult parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static IamPolicySearchResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static IamPolicySearchResult parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static IamPolicySearchResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<IamPolicySearchResult> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAssetType()
public 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;
| Type | Description |
| String | The assetType.
|
getAssetTypeBytes()
public 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;
getDefaultInstanceForType()
public IamPolicySearchResult getDefaultInstanceForType()
Returns
getExplanation()
public 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;
getExplanationOrBuilder()
public 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;
getFolders(int index)
public 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;
| 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 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;
| 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 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;
| Type | Description |
| int | The count of folders.
|
getFoldersList()
public ProtocolStringList 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;
getOrganization()
public 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;
| Type | Description |
| String | The organization.
|
getOrganizationBytes()
public 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;
| Type | Description |
| ByteString | The bytes for organization.
|
getParserForType()
public Parser<IamPolicySearchResult> getParserForType()
Returns
Overrides
getPolicy()
public 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;
| Type | Description |
| com.google.iam.v1.Policy | The policy.
|
getPolicyOrBuilder()
public 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;
| Type | Description |
| com.google.iam.v1.PolicyOrBuilder | |
getProject()
public 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;
| Type | Description |
| String | The project.
|
getProjectBytes()
public 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;
getResource()
public 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;
| Type | Description |
| String | The resource.
|
getResourceBytes()
public 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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasExplanation()
public 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;
| Type | Description |
| boolean | Whether the explanation field is set.
|
hasPolicy()
public 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;
| Type | Description |
| boolean | Whether the policy field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public IamPolicySearchResult.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected IamPolicySearchResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public IamPolicySearchResult.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
