Class AnalyzeIamPolicyRequest (3.51.0)

public final class AnalyzeIamPolicyRequest extends GeneratedMessageV3 implements AnalyzeIamPolicyRequestOrBuilder

A request message for AssetService.AnalyzeIamPolicy.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyRequest

Static Fields

ANALYSIS_QUERY_FIELD_NUMBER

public static final int ANALYSIS_QUERY_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_TIMEOUT_FIELD_NUMBER

public static final int EXECUTION_TIMEOUT_FIELD_NUMBER
Field Value
Type Description
int

SAVED_ANALYSIS_QUERY_FIELD_NUMBER

public static final int SAVED_ANALYSIS_QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnalyzeIamPolicyRequest getDefaultInstance()
Returns
Type Description
AnalyzeIamPolicyRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AnalyzeIamPolicyRequest.Builder newBuilder()
Returns
Type Description
AnalyzeIamPolicyRequest.Builder

newBuilder(AnalyzeIamPolicyRequest prototype)

public static AnalyzeIamPolicyRequest.Builder newBuilder(AnalyzeIamPolicyRequest prototype)
Parameter
Name Description
prototype AnalyzeIamPolicyRequest
Returns
Type Description
AnalyzeIamPolicyRequest.Builder

parseDelimitedFrom(InputStream input)

public static AnalyzeIamPolicyRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnalyzeIamPolicyRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnalyzeIamPolicyRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeIamPolicyRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AnalyzeIamPolicyRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AnalyzeIamPolicyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnalyzeIamPolicyRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeIamPolicyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnalyzeIamPolicyRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnalyzeIamPolicyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnalyzeIamPolicyRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeIamPolicyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnalyzeIamPolicyRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnalyzeIamPolicyRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnalyzeIamPolicyRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeIamPolicyRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AnalyzeIamPolicyRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnalyzeIamPolicyRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnalyzeIamPolicyRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeIamPolicyRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AnalyzeIamPolicyRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnalyzeIamPolicyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnalyzeIamPolicyRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeIamPolicyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AnalyzeIamPolicyRequest> parser()
Returns
Type Description
Parser<AnalyzeIamPolicyRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnalysisQuery()

public IamPolicyAnalysisQuery getAnalysisQuery()

Required. The request query.

.google.cloud.asset.v1.IamPolicyAnalysisQuery analysis_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IamPolicyAnalysisQuery

The analysisQuery.

getAnalysisQueryOrBuilder()

public IamPolicyAnalysisQueryOrBuilder getAnalysisQueryOrBuilder()

Required. The request query.

.google.cloud.asset.v1.IamPolicyAnalysisQuery analysis_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IamPolicyAnalysisQueryOrBuilder

getDefaultInstanceForType()

public AnalyzeIamPolicyRequest getDefaultInstanceForType()
Returns
Type Description
AnalyzeIamPolicyRequest

getExecutionTimeout()

public Duration getExecutionTimeout()

Optional. Amount of time executable has to complete. See JSON representation of Duration.

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.

.google.protobuf.Duration execution_timeout = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The executionTimeout.

getExecutionTimeoutOrBuilder()

public DurationOrBuilder getExecutionTimeoutOrBuilder()

Optional. Amount of time executable has to complete. See JSON representation of Duration.

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.

.google.protobuf.Duration execution_timeout = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getParserForType()

public Parser<AnalyzeIamPolicyRequest> getParserForType()
Returns
Type Description
Parser<AnalyzeIamPolicyRequest>
Overrides

getSavedAnalysisQuery()

public String getSavedAnalysisQuery()

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, refer to the MergeFrom 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.

string saved_analysis_query = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The savedAnalysisQuery.

getSavedAnalysisQueryBytes()

public ByteString getSavedAnalysisQueryBytes()

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, refer to the MergeFrom 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.

string saved_analysis_query = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for savedAnalysisQuery.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAnalysisQuery()

public boolean hasAnalysisQuery()

Required. The request query.

.google.cloud.asset.v1.IamPolicyAnalysisQuery analysis_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the analysisQuery field is set.

hasExecutionTimeout()

public boolean hasExecutionTimeout()

Optional. Amount of time executable has to complete. See JSON representation of Duration.

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.

.google.protobuf.Duration execution_timeout = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the executionTimeout field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AnalyzeIamPolicyRequest.Builder newBuilderForType()
Returns
Type Description
AnalyzeIamPolicyRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnalyzeIamPolicyRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AnalyzeIamPolicyRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AnalyzeIamPolicyRequest.Builder toBuilder()
Returns
Type Description
AnalyzeIamPolicyRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException