Cloud Asset V1 API - Class Google::Cloud::Asset::V1::AnalyzeIamPolicyRequest (v0.31.0)

Reference documentation and code samples for the Cloud Asset V1 API class Google::Cloud::Asset::V1::AnalyzeIamPolicyRequest.

A request message for AssetService.AnalyzeIamPolicy.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#analysis_query

def analysis_query() -> ::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery
Returns

#analysis_query=

def analysis_query=(value) -> ::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery
Parameter
Returns

#execution_timeout

def execution_timeout() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — 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.

#execution_timeout=

def execution_timeout=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — 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.

Returns
  • (::Google::Protobuf::Duration) — 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.

#saved_analysis_query

def saved_analysis_query() -> ::String
Returns
  • (::String) — 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.

#saved_analysis_query=

def saved_analysis_query=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.