Interface AnalyzeIamPolicyRequestOrBuilder (3.51.0) 

public interface AnalyzeIamPolicyRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnalysisQuery()

public abstract 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 abstract IamPolicyAnalysisQueryOrBuilder getAnalysisQueryOrBuilder()

Required. The request query.

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

Returns
Type Description
IamPolicyAnalysisQueryOrBuilder

getExecutionTimeout()

public abstract 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 abstract 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

getSavedAnalysisQuery()

public abstract 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 abstract 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.

hasAnalysisQuery()

public abstract 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 abstract 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.