Class QueryRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
studio.o7.octopus.sdk.v1.QueryRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, QueryRequestOrBuilder
public final class QueryRequest extends com.google.protobuf.GeneratedMessage implements QueryRequestOrBuilder
*
Filters and options for `Query` RPC.
Protobuf type octopus_sdk.v1.QueryRequest
See Also:

  • Field Details

    • KEY_PATTERN_FIELD_NUMBER

      public static final int KEY_PATTERN_FIELD_NUMBER
      See Also:

    • INCLUDE_EXPIRED_FIELD_NUMBER

      public static final int INCLUDE_EXPIRED_FIELD_NUMBER
      See Also:

    • CREATED_AT_RANGE_START_FIELD_NUMBER

      public static final int CREATED_AT_RANGE_START_FIELD_NUMBER
      See Also:

    • CREATED_AT_RANGE_END_FIELD_NUMBER

      public static final int CREATED_AT_RANGE_END_FIELD_NUMBER
      See Also:

    • DATA_FILTER_FIELD_NUMBER

      public static final int DATA_FILTER_FIELD_NUMBER
      See Also:

    • DATA_SORT_FIELD_NUMBER

      public static final int DATA_SORT_FIELD_NUMBER
      See Also:

    • PAGINATOR_FIELD_NUMBER

      public static final int PAGINATOR_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getKeyPattern

      public String getKeyPattern()
      Pattern to match keys. Supports wildcards:
*  — matches exactly one token (between dots), e.g., "foo.*.bar" matches "foo.x.bar" but not "foo.x.y.bar"
>  — matches one or more tokens until the end, e.g., "foo.>" matches "foo", "foo.bar", "foo.bar.baz", etc.
Multiple wildcards can be used in a single pattern. Tokens are dot-separated.
      string key_pattern = 1 [json_name = "keyPattern"];
      Specified by:
      getKeyPattern in interface QueryRequestOrBuilder
      Returns:
      The keyPattern.

    • getKeyPatternBytes

      public com.google.protobuf.ByteString getKeyPatternBytes()
      Pattern to match keys. Supports wildcards:
*  — matches exactly one token (between dots), e.g., "foo.*.bar" matches "foo.x.bar" but not "foo.x.y.bar"
>  — matches one or more tokens until the end, e.g., "foo.>" matches "foo", "foo.bar", "foo.bar.baz", etc.
Multiple wildcards can be used in a single pattern. Tokens are dot-separated.
      string key_pattern = 1 [json_name = "keyPattern"];
      Specified by:
      getKeyPatternBytes in interface QueryRequestOrBuilder
      Returns:
      The bytes for keyPattern.

    • hasIncludeExpired

      public boolean hasIncludeExpired()
      Whether to include expired objects.
      optional bool include_expired = 2 [json_name = "includeExpired"];
      Specified by:
      hasIncludeExpired in interface QueryRequestOrBuilder
      Returns:
      Whether the includeExpired field is set.

    • getIncludeExpired

      public boolean getIncludeExpired()
      Whether to include expired objects.
      optional bool include_expired = 2 [json_name = "includeExpired"];
      Specified by:
      getIncludeExpired in interface QueryRequestOrBuilder
      Returns:
      The includeExpired.

    • hasCreatedAtRangeStart

      public boolean hasCreatedAtRangeStart()
      Start timestamp to filter creation time.
      optional .google.protobuf.Timestamp created_at_range_start = 3 [json_name = "createdAtRangeStart"];
      Specified by:
      hasCreatedAtRangeStart in interface QueryRequestOrBuilder
      Returns:
      Whether the createdAtRangeStart field is set.

    • getCreatedAtRangeStart

      public com.google.protobuf.Timestamp getCreatedAtRangeStart()
      Start timestamp to filter creation time.
      optional .google.protobuf.Timestamp created_at_range_start = 3 [json_name = "createdAtRangeStart"];
      Specified by:
      getCreatedAtRangeStart in interface QueryRequestOrBuilder
      Returns:
      The createdAtRangeStart.

    • getCreatedAtRangeStartOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreatedAtRangeStartOrBuilder()
      Start timestamp to filter creation time.
      optional .google.protobuf.Timestamp created_at_range_start = 3 [json_name = "createdAtRangeStart"];
      Specified by:
      getCreatedAtRangeStartOrBuilder in interface QueryRequestOrBuilder

    • hasCreatedAtRangeEnd

      public boolean hasCreatedAtRangeEnd()
      End timestamp to filter creation time.
      optional .google.protobuf.Timestamp created_at_range_end = 4 [json_name = "createdAtRangeEnd"];
      Specified by:
      hasCreatedAtRangeEnd in interface QueryRequestOrBuilder
      Returns:
      Whether the createdAtRangeEnd field is set.

    • getCreatedAtRangeEnd

      public com.google.protobuf.Timestamp getCreatedAtRangeEnd()
      End timestamp to filter creation time.
      optional .google.protobuf.Timestamp created_at_range_end = 4 [json_name = "createdAtRangeEnd"];
      Specified by:
      getCreatedAtRangeEnd in interface QueryRequestOrBuilder
      Returns:
      The createdAtRangeEnd.

    • getCreatedAtRangeEndOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreatedAtRangeEndOrBuilder()
      End timestamp to filter creation time.
      optional .google.protobuf.Timestamp created_at_range_end = 4 [json_name = "createdAtRangeEnd"];
      Specified by:
      getCreatedAtRangeEndOrBuilder in interface QueryRequestOrBuilder

    • hasDataFilter

      public boolean hasDataFilter()
      Filter by json (use MongoDB filter pattern)
      optional string data_filter = 5 [json_name = "dataFilter"];
      Specified by:
      hasDataFilter in interface QueryRequestOrBuilder
      Returns:
      Whether the dataFilter field is set.

    • getDataFilter

      public String getDataFilter()
      Filter by json (use MongoDB filter pattern)
      optional string data_filter = 5 [json_name = "dataFilter"];
      Specified by:
      getDataFilter in interface QueryRequestOrBuilder
      Returns:
      The dataFilter.

    • getDataFilterBytes

      public com.google.protobuf.ByteString getDataFilterBytes()
      Filter by json (use MongoDB filter pattern)
      optional string data_filter = 5 [json_name = "dataFilter"];
      Specified by:
      getDataFilterBytes in interface QueryRequestOrBuilder
      Returns:
      The bytes for dataFilter.

    • hasDataSort

      public boolean hasDataSort()
      Sort by json (use MongoDB sort pattern)
      optional string data_sort = 6 [json_name = "dataSort"];
      Specified by:
      hasDataSort in interface QueryRequestOrBuilder
      Returns:
      Whether the dataSort field is set.

    • getDataSort

      public String getDataSort()
      Sort by json (use MongoDB sort pattern)
      optional string data_sort = 6 [json_name = "dataSort"];
      Specified by:
      getDataSort in interface QueryRequestOrBuilder
      Returns:
      The dataSort.

    • getDataSortBytes

      public com.google.protobuf.ByteString getDataSortBytes()
      Sort by json (use MongoDB sort pattern)
      optional string data_sort = 6 [json_name = "dataSort"];
      Specified by:
      getDataSortBytes in interface QueryRequestOrBuilder
      Returns:
      The bytes for dataSort.

    • hasPaginator

      public boolean hasPaginator()
      Entry paginator
      .octopus_sdk.v1.Paginator paginator = 7 [json_name = "paginator"];
      Specified by:
      hasPaginator in interface QueryRequestOrBuilder
      Returns:
      Whether the paginator field is set.

    • getPaginator

      public Paginator getPaginator()
      Entry paginator
      .octopus_sdk.v1.Paginator paginator = 7 [json_name = "paginator"];
      Specified by:
      getPaginator in interface QueryRequestOrBuilder
      Returns:
      The paginator.

    • getPaginatorOrBuilder

      public PaginatorOrBuilder getPaginatorOrBuilder()
      Entry paginator
      .octopus_sdk.v1.Paginator paginator = 7 [json_name = "paginator"];
      Specified by:
      getPaginatorOrBuilder in interface QueryRequestOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static QueryRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QueryRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static QueryRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static QueryRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QueryRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static QueryRequest.Builder newBuilder()

    • newBuilder

      public static QueryRequest.Builder newBuilder(QueryRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected QueryRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static QueryRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<QueryRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<QueryRequest> 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.GeneratedMessage

    • getDefaultInstanceForType

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