Class ListInsightsRequest

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

    public final class ListInsightsRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements ListInsightsRequestOrBuilder
     Request for the `ListInsights` method.
     
    Protobuf type google.cloud.recommender.v1beta1.ListInsightsRequest
    See Also:
    Serialized Form
    • 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
      • getParent

        public String getParent()
         Required. The container resource on which to execute the request.
         Acceptable formats:
        
         * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
        
         * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
        
         * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
        
         * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
        
         * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
        
         LOCATION here refers to GCP Locations:
         https://cloud.google.com/about/locations/
         INSIGHT_TYPE_ID refers to supported insight types:
         https://cloud.google.com/recommender/docs/insights/insight-types.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListInsightsRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The container resource on which to execute the request.
         Acceptable formats:
        
         * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
        
         * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
        
         * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
        
         * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
        
         * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
        
         LOCATION here refers to GCP Locations:
         https://cloud.google.com/about/locations/
         INSIGHT_TYPE_ID refers to supported insight types:
         https://cloud.google.com/recommender/docs/insights/insight-types.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListInsightsRequestOrBuilder
        Returns:
        The bytes for parent.
      • getPageSize

        public int getPageSize()
         Optional. The maximum number of results to return from this request.
         Non-positive values are ignored. If not specified, the server will
         determine the number of results to return.
         
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageSize in interface ListInsightsRequestOrBuilder
        Returns:
        The pageSize.
      • getPageToken

        public String getPageToken()
         Optional. If present, retrieves the next batch of results from the
         preceding call to this method. `page_token` must be the value of
         `next_page_token` from the previous response. The values of other method
         parameters must be identical to those in the previous call.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageToken in interface ListInsightsRequestOrBuilder
        Returns:
        The pageToken.
      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Optional. If present, retrieves the next batch of results from the
         preceding call to this method. `page_token` must be the value of
         `next_page_token` from the previous response. The values of other method
         parameters must be identical to those in the previous call.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageTokenBytes in interface ListInsightsRequestOrBuilder
        Returns:
        The bytes for pageToken.
      • getFilter

        public String getFilter()
         Optional. Filter expression to restrict the insights returned. Supported
         filter fields:
        
         * `stateInfo.state`
        
         * `insightSubtype`
        
         * `severity`
        
         Examples:
        
         * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`
        
         * `insightSubtype = PERMISSIONS_USAGE`
        
         * `severity = CRITICAL OR severity = HIGH`
        
         * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)`
        
         (These expressions are based on the filter language described at
         https://google.aip.dev/160)
         
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilter in interface ListInsightsRequestOrBuilder
        Returns:
        The filter.
      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Optional. Filter expression to restrict the insights returned. Supported
         filter fields:
        
         * `stateInfo.state`
        
         * `insightSubtype`
        
         * `severity`
        
         Examples:
        
         * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`
        
         * `insightSubtype = PERMISSIONS_USAGE`
        
         * `severity = CRITICAL OR severity = HIGH`
        
         * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)`
        
         (These expressions are based on the filter language described at
         https://google.aip.dev/160)
         
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilterBytes in interface ListInsightsRequestOrBuilder
        Returns:
        The bytes for filter.
      • 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 ListInsightsRequest parseFrom​(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

        public static ListInsightsRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

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

        public com.google.protobuf.Parser<ListInsightsRequest> 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 ListInsightsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder