Class AnalyzeIamPolicyRequest

  • All Implemented Interfaces:
    AnalyzeIamPolicyRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class AnalyzeIamPolicyRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements AnalyzeIamPolicyRequestOrBuilder
     A request message for
     [AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.AssetService.AnalyzeIamPolicy].
     
    Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyRequest
    See Also:
    Serialized Form
    • Field Detail

      • ANALYSIS_QUERY_FIELD_NUMBER

        public static final int ANALYSIS_QUERY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SAVED_ANALYSIS_QUERY_FIELD_NUMBER

        public static final int SAVED_ANALYSIS_QUERY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • EXECUTION_TIMEOUT_FIELD_NUMBER

        public static final int EXECUTION_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasAnalysisQuery

        public boolean hasAnalysisQuery()
         Required. The request query.
         
        .google.cloud.asset.v1.IamPolicyAnalysisQuery analysis_query = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasAnalysisQuery in interface AnalyzeIamPolicyRequestOrBuilder
        Returns:
        Whether the analysisQuery field is set.
      • 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,
         please refer to the
         [MergeFrom](https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.message#Message.MergeFrom.details)
         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];
        Specified by:
        getSavedAnalysisQuery in interface AnalyzeIamPolicyRequestOrBuilder
        Returns:
        The savedAnalysisQuery.
      • getSavedAnalysisQueryBytes

        public com.google.protobuf.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,
         please refer to the
         [MergeFrom](https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.message#Message.MergeFrom.details)
         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];
        Specified by:
        getSavedAnalysisQueryBytes in interface AnalyzeIamPolicyRequestOrBuilder
        Returns:
        The bytes for savedAnalysisQuery.
      • hasExecutionTimeout

        public boolean hasExecutionTimeout()
         Optional. Amount of time executable has to complete.  See JSON
         representation of
         [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json).
        
         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];
        Specified by:
        hasExecutionTimeout in interface AnalyzeIamPolicyRequestOrBuilder
        Returns:
        Whether the executionTimeout field is set.
      • getExecutionTimeout

        public com.google.protobuf.Duration getExecutionTimeout()
         Optional. Amount of time executable has to complete.  See JSON
         representation of
         [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json).
        
         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];
        Specified by:
        getExecutionTimeout in interface AnalyzeIamPolicyRequestOrBuilder
        Returns:
        The executionTimeout.
      • getExecutionTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getExecutionTimeoutOrBuilder()
         Optional. Amount of time executable has to complete.  See JSON
         representation of
         [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json).
        
         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];
        Specified by:
        getExecutionTimeoutOrBuilder in interface AnalyzeIamPolicyRequestOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static AnalyzeIamPolicyRequest parseFrom​(ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AnalyzeIamPolicyRequest parseFrom​(ByteBuffer data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AnalyzeIamPolicyRequest parseFrom​(com.google.protobuf.ByteString data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AnalyzeIamPolicyRequest parseFrom​(com.google.protobuf.ByteString data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AnalyzeIamPolicyRequest parseFrom​(byte[] data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AnalyzeIamPolicyRequest parseFrom​(byte[] data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public AnalyzeIamPolicyRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public AnalyzeIamPolicyRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected AnalyzeIamPolicyRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<AnalyzeIamPolicyRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public AnalyzeIamPolicyRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder