Class ExecuteDashboardQueryRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.chronicle.v1.ExecuteDashboardQueryRequest
All Implemented Interfaces:
ExecuteDashboardQueryRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class ExecuteDashboardQueryRequest extends com.google.protobuf.GeneratedMessage implements ExecuteDashboardQueryRequestOrBuilder
 Request message to execute a dashboard query.
 
Protobuf type google.cloud.chronicle.v1.ExecuteDashboardQueryRequest
See Also:
  • Field Details

    • PARENT_FIELD_NUMBER

      public static final int PARENT_FIELD_NUMBER
      See Also:
    • QUERY_FIELD_NUMBER

      public static final int QUERY_FIELD_NUMBER
      See Also:
    • FILTERS_FIELD_NUMBER

      public static final int FILTERS_FIELD_NUMBER
      See Also:
    • CLEAR_CACHE_FIELD_NUMBER

      public static final int CLEAR_CACHE_FIELD_NUMBER
      See Also:
    • USE_PREVIOUS_TIME_RANGE_FIELD_NUMBER

      public static final int USE_PREVIOUS_TIME_RANGE_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
    • getParent

      public String getParent()
       Required. The parent, under which to run this dashboardQuery.
       Format: projects/{project}/locations/{location}/instances/{instance}
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ExecuteDashboardQueryRequestOrBuilder
      Returns:
      The parent.
    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The parent, under which to run this dashboardQuery.
       Format: projects/{project}/locations/{location}/instances/{instance}
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ExecuteDashboardQueryRequestOrBuilder
      Returns:
      The bytes for parent.
    • hasQuery

      public boolean hasQuery()
       Required. The query to execute and get results back for.
       QueryID or 'query', 'input.time_window' fields will be used. Use
       'native_dashboard' and 'dashboard_chart' fields if it is an in-dashboard
       query.
       
      .google.cloud.chronicle.v1.DashboardQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasQuery in interface ExecuteDashboardQueryRequestOrBuilder
      Returns:
      Whether the query field is set.
    • getQuery

      public DashboardQuery getQuery()
       Required. The query to execute and get results back for.
       QueryID or 'query', 'input.time_window' fields will be used. Use
       'native_dashboard' and 'dashboard_chart' fields if it is an in-dashboard
       query.
       
      .google.cloud.chronicle.v1.DashboardQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuery in interface ExecuteDashboardQueryRequestOrBuilder
      Returns:
      The query.
    • getQueryOrBuilder

      public DashboardQueryOrBuilder getQueryOrBuilder()
       Required. The query to execute and get results back for.
       QueryID or 'query', 'input.time_window' fields will be used. Use
       'native_dashboard' and 'dashboard_chart' fields if it is an in-dashboard
       query.
       
      .google.cloud.chronicle.v1.DashboardQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryOrBuilder in interface ExecuteDashboardQueryRequestOrBuilder
    • getFiltersList

      public List<DashboardFilter> getFiltersList()
       Optional. Dashboard level filters other than query string.
       
      repeated .google.cloud.chronicle.v1.DashboardFilter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFiltersList in interface ExecuteDashboardQueryRequestOrBuilder
    • getFiltersOrBuilderList

      public List<? extends DashboardFilterOrBuilder> getFiltersOrBuilderList()
       Optional. Dashboard level filters other than query string.
       
      repeated .google.cloud.chronicle.v1.DashboardFilter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFiltersOrBuilderList in interface ExecuteDashboardQueryRequestOrBuilder
    • getFiltersCount

      public int getFiltersCount()
       Optional. Dashboard level filters other than query string.
       
      repeated .google.cloud.chronicle.v1.DashboardFilter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFiltersCount in interface ExecuteDashboardQueryRequestOrBuilder
    • getFilters

      public DashboardFilter getFilters(int index)
       Optional. Dashboard level filters other than query string.
       
      repeated .google.cloud.chronicle.v1.DashboardFilter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilters in interface ExecuteDashboardQueryRequestOrBuilder
    • getFiltersOrBuilder

      public DashboardFilterOrBuilder getFiltersOrBuilder(int index)
       Optional. Dashboard level filters other than query string.
       
      repeated .google.cloud.chronicle.v1.DashboardFilter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFiltersOrBuilder in interface ExecuteDashboardQueryRequestOrBuilder
    • getClearCache

      public boolean getClearCache()
       Optional. When true, the backend would read from the database, rather than
       fetching data directly from the cache.
       
      bool clear_cache = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getClearCache in interface ExecuteDashboardQueryRequestOrBuilder
      Returns:
      The clearCache.
    • getUsePreviousTimeRange

      public boolean getUsePreviousTimeRange()
       Optional. When true, the backend will execute the query against the
       previous time range of the query.
       
      bool use_previous_time_range = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUsePreviousTimeRange in interface ExecuteDashboardQueryRequestOrBuilder
      Returns:
      The usePreviousTimeRange.
    • 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 ExecuteDashboardQueryRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static ExecuteDashboardQueryRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static ExecuteDashboardQueryRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static ExecuteDashboardQueryRequest.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

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

      public static ExecuteDashboardQueryRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<ExecuteDashboardQueryRequest> parser()
    • getParserForType

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