Class AnalyzeIamPolicyRequest.Builder (3.87.0)

public static final class AnalyzeIamPolicyRequest.Builder extends GeneratedMessage.Builder<AnalyzeIamPolicyRequest.Builder> implements AnalyzeIamPolicyRequestOrBuilder

A request message for AssetService.AnalyzeIamPolicy.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyRequest

Static Methods

getDescriptor()

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

Methods

build()

public AnalyzeIamPolicyRequest build()
Returns
Type Description
AnalyzeIamPolicyRequest

buildPartial()

public AnalyzeIamPolicyRequest buildPartial()
Returns
Type Description
AnalyzeIamPolicyRequest

clear()

public AnalyzeIamPolicyRequest.Builder clear()
Returns
Type Description
AnalyzeIamPolicyRequest.Builder
Overrides

clearAnalysisQuery()

public AnalyzeIamPolicyRequest.Builder clearAnalysisQuery()

Required. The request query.

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

Returns
Type Description
AnalyzeIamPolicyRequest.Builder

clearExecutionTimeout()

public AnalyzeIamPolicyRequest.Builder clearExecutionTimeout()

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
AnalyzeIamPolicyRequest.Builder

clearSavedAnalysisQuery()

public AnalyzeIamPolicyRequest.Builder clearSavedAnalysisQuery()

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
AnalyzeIamPolicyRequest.Builder

This builder for chaining.

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.

getAnalysisQueryBuilder()

public IamPolicyAnalysisQuery.Builder getAnalysisQueryBuilder()

Required. The request query.

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

Returns
Type Description
IamPolicyAnalysisQuery.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getExecutionTimeoutBuilder()

public Duration.Builder getExecutionTimeoutBuilder()

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
Builder

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

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAnalysisQuery(IamPolicyAnalysisQuery value)

public AnalyzeIamPolicyRequest.Builder mergeAnalysisQuery(IamPolicyAnalysisQuery value)

Required. The request query.

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

Parameter
Name Description
value IamPolicyAnalysisQuery
Returns
Type Description
AnalyzeIamPolicyRequest.Builder

mergeExecutionTimeout(Duration value)

public AnalyzeIamPolicyRequest.Builder mergeExecutionTimeout(Duration value)

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];

Parameter
Name Description
value Duration
Returns
Type Description
AnalyzeIamPolicyRequest.Builder

mergeFrom(AnalyzeIamPolicyRequest other)

public AnalyzeIamPolicyRequest.Builder mergeFrom(AnalyzeIamPolicyRequest other)
Parameter
Name Description
other AnalyzeIamPolicyRequest
Returns
Type Description
AnalyzeIamPolicyRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AnalyzeIamPolicyRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeIamPolicyRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AnalyzeIamPolicyRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AnalyzeIamPolicyRequest.Builder
Overrides

setAnalysisQuery(IamPolicyAnalysisQuery value)

public AnalyzeIamPolicyRequest.Builder setAnalysisQuery(IamPolicyAnalysisQuery value)

Required. The request query.

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

Parameter
Name Description
value IamPolicyAnalysisQuery
Returns
Type Description
AnalyzeIamPolicyRequest.Builder

setAnalysisQuery(IamPolicyAnalysisQuery.Builder builderForValue)

public AnalyzeIamPolicyRequest.Builder setAnalysisQuery(IamPolicyAnalysisQuery.Builder builderForValue)

Required. The request query.

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

Parameter
Name Description
builderForValue IamPolicyAnalysisQuery.Builder
Returns
Type Description
AnalyzeIamPolicyRequest.Builder

setExecutionTimeout(Duration value)

public AnalyzeIamPolicyRequest.Builder setExecutionTimeout(Duration value)

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];

Parameter
Name Description
value Duration
Returns
Type Description
AnalyzeIamPolicyRequest.Builder

setExecutionTimeout(Duration.Builder builderForValue)

public AnalyzeIamPolicyRequest.Builder setExecutionTimeout(Duration.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AnalyzeIamPolicyRequest.Builder

setSavedAnalysisQuery(String value)

public AnalyzeIamPolicyRequest.Builder setSavedAnalysisQuery(String value)

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];

Parameter
Name Description
value String

The savedAnalysisQuery to set.

Returns
Type Description
AnalyzeIamPolicyRequest.Builder

This builder for chaining.

setSavedAnalysisQueryBytes(ByteString value)

public AnalyzeIamPolicyRequest.Builder setSavedAnalysisQueryBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for savedAnalysisQuery to set.

Returns
Type Description
AnalyzeIamPolicyRequest.Builder

This builder for chaining.