Package com.google.cloud.securitycenter.v1beta1

Class ListFindingsRequest

  • All Implemented Interfaces:
    ListFindingsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListFindingsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListFindingsRequestOrBuilder
     Request message for listing findings.
    Protobuf type google.cloud.securitycenter.v1beta1.ListFindingsRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ListFindingsRequest.Builder
      Request message for listing findings.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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. Name of the source the findings belong to. Its format is
 "organizations/[organization_id]/sources/[source_id]". To list across all
 sources provide a source_id of `-`. For example:
 organizations/{organization_id}/sources/-
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListFindingsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. Name of the source the findings belong to. Its format is
 "organizations/[organization_id]/sources/[source_id]". To list across all
 sources provide a source_id of `-`. For example:
 organizations/{organization_id}/sources/-
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListFindingsRequestOrBuilder
        Returns:
        The bytes for parent.

      • getFilter

        public String getFilter()
         Expression that defines the filter to apply across findings.
 The expression is a list of one or more restrictions combined via logical
 operators `AND` and `OR`.
 Parentheses are not supported, and `OR` has higher precedence than `AND`.

 Restrictions have the form `<field> <operator> <value>` and may have a `-`
 character in front of them to indicate negation. Examples include:

  * name
  * source_properties.a_property
  * security_marks.marks.marka

 The supported operators are:

 * `=` for all value types.
 * `>`, `<`, `>=`, `<=` for integer values.
 * `:`, meaning substring matching, for strings.

 The supported value types are:

 * string literals in quotes.
 * integer literals without quotes.
 * boolean literals `true` and `false` without quotes.

 For example, `source_properties.size = 100` is a valid filter string.
        string filter = 2;
        Specified by:
        getFilter in interface ListFindingsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Expression that defines the filter to apply across findings.
 The expression is a list of one or more restrictions combined via logical
 operators `AND` and `OR`.
 Parentheses are not supported, and `OR` has higher precedence than `AND`.

 Restrictions have the form `<field> <operator> <value>` and may have a `-`
 character in front of them to indicate negation. Examples include:

  * name
  * source_properties.a_property
  * security_marks.marks.marka

 The supported operators are:

 * `=` for all value types.
 * `>`, `<`, `>=`, `<=` for integer values.
 * `:`, meaning substring matching, for strings.

 The supported value types are:

 * string literals in quotes.
 * integer literals without quotes.
 * boolean literals `true` and `false` without quotes.

 For example, `source_properties.size = 100` is a valid filter string.
        string filter = 2;
        Specified by:
        getFilterBytes in interface ListFindingsRequestOrBuilder
        Returns:
        The bytes for filter.

      • getOrderBy

        public String getOrderBy()
         Expression that defines what fields and order to use for sorting. The
 string value should follow SQL syntax: comma separated list of fields. For
 example: "name,resource_properties.a_property". The default sorting order
 is ascending. To specify descending order for a field, a suffix " desc"
 should be appended to the field name. For example: "name
 desc,source_properties.a_property". Redundant space characters in the
 syntax are insignificant. "name desc,source_properties.a_property" and "
 name     desc  ,   source_properties.a_property  " are equivalent.
        string order_by = 3;
        Specified by:
        getOrderBy in interface ListFindingsRequestOrBuilder
        Returns:
        The orderBy.

      • getOrderByBytes

        public com.google.protobuf.ByteString getOrderByBytes()
         Expression that defines what fields and order to use for sorting. The
 string value should follow SQL syntax: comma separated list of fields. For
 example: "name,resource_properties.a_property". The default sorting order
 is ascending. To specify descending order for a field, a suffix " desc"
 should be appended to the field name. For example: "name
 desc,source_properties.a_property". Redundant space characters in the
 syntax are insignificant. "name desc,source_properties.a_property" and "
 name     desc  ,   source_properties.a_property  " are equivalent.
        string order_by = 3;
        Specified by:
        getOrderByBytes in interface ListFindingsRequestOrBuilder
        Returns:
        The bytes for orderBy.

      • hasReadTime

        public boolean hasReadTime()
         Time used as a reference point when filtering findings. The filter is
 limited to findings existing at the supplied time and their values are
 those at that specific time. Absence of this field will default to the
 API's version of NOW.
        .google.protobuf.Timestamp read_time = 4;
        Specified by:
        hasReadTime in interface ListFindingsRequestOrBuilder
        Returns:
        Whether the readTime field is set.

      • getReadTime

        public com.google.protobuf.Timestamp getReadTime()
         Time used as a reference point when filtering findings. The filter is
 limited to findings existing at the supplied time and their values are
 those at that specific time. Absence of this field will default to the
 API's version of NOW.
        .google.protobuf.Timestamp read_time = 4;
        Specified by:
        getReadTime in interface ListFindingsRequestOrBuilder
        Returns:
        The readTime.

      • getReadTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
         Time used as a reference point when filtering findings. The filter is
 limited to findings existing at the supplied time and their values are
 those at that specific time. Absence of this field will default to the
 API's version of NOW.
        .google.protobuf.Timestamp read_time = 4;
        Specified by:
        getReadTimeOrBuilder in interface ListFindingsRequestOrBuilder

      • hasFieldMask

        public boolean hasFieldMask()
         Optional. A field mask to specify the Finding fields to be listed in the response.
 An empty field mask will list all fields.
        .google.protobuf.FieldMask field_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasFieldMask in interface ListFindingsRequestOrBuilder
        Returns:
        Whether the fieldMask field is set.

      • getFieldMask

        public com.google.protobuf.FieldMask getFieldMask()
         Optional. A field mask to specify the Finding fields to be listed in the response.
 An empty field mask will list all fields.
        .google.protobuf.FieldMask field_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFieldMask in interface ListFindingsRequestOrBuilder
        Returns:
        The fieldMask.

      • getFieldMaskOrBuilder

        public com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()
         Optional. A field mask to specify the Finding fields to be listed in the response.
 An empty field mask will list all fields.
        .google.protobuf.FieldMask field_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFieldMaskOrBuilder in interface ListFindingsRequestOrBuilder

      • getPageToken

        public String getPageToken()
         The value returned by the last `ListFindingsResponse`; indicates
 that this is a continuation of a prior `ListFindings` call, and
 that the system should return the next page of data.
        string page_token = 6;
        Specified by:
        getPageToken in interface ListFindingsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         The value returned by the last `ListFindingsResponse`; indicates
 that this is a continuation of a prior `ListFindings` call, and
 that the system should return the next page of data.
        string page_token = 6;
        Specified by:
        getPageTokenBytes in interface ListFindingsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getPageSize

        public int getPageSize()
         The maximum number of results to return in a single response. Default is
 10, minimum is 1, maximum is 1000.
        int32 page_size = 7;
        Specified by:
        getPageSize in interface ListFindingsRequestOrBuilder
        Returns:
        The pageSize.

      • 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 ListFindingsRequest parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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