Package com.google.cloud.retail.v2alpha

Interface ExportAnalyticsMetricsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExportAnalyticsMetricsRequest, ExportAnalyticsMetricsRequest.Builder
@Generated public interface ExportAnalyticsMetricsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCatalog()
    Required.
    com.google.protobuf.ByteString
    getCatalogBytes()
    Required.
    String
    getFilter()
    A filtering expression to specify restrictions on returned metrics.
    com.google.protobuf.ByteString
    getFilterBytes()
    A filtering expression to specify restrictions on returned metrics.
    OutputConfig
    getOutputConfig()
    Required.
    OutputConfigOrBuilder
    getOutputConfigOrBuilder()
    Required.
    boolean
    hasOutputConfig()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getCatalog

      String getCatalog()
       Required. Full resource name of the parent catalog.
 Expected format: `projects/*/locations/*/catalogs/*`
      string catalog = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The catalog.

    • getCatalogBytes

      com.google.protobuf.ByteString getCatalogBytes()
       Required. Full resource name of the parent catalog.
 Expected format: `projects/*/locations/*/catalogs/*`
      string catalog = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for catalog.

    • hasOutputConfig

      boolean hasOutputConfig()
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the outputConfig field is set.

    • getOutputConfig

      OutputConfig getOutputConfig()
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The outputConfig.

    • getOutputConfigOrBuilder

      OutputConfigOrBuilder getOutputConfigOrBuilder()
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

    • getFilter

      String getFilter()
       A filtering expression to specify restrictions on returned metrics.
 The expression is a sequence of terms. Each term applies a restriction to
 the returned metrics. Use this expression to restrict results to a
 specific time range.

 Currently we expect only one types of fields:

 * `timestamp`: This can be specified twice, once with a
 less than operator and once with a greater than operator. The
 `timestamp` restriction should result in one, contiguous, valid,
 `timestamp` range.

 Some examples of valid filters expressions:

 * Example 1: `timestamp > "2012-04-23T18:25:43.511Z"
 timestamp < "2012-04-23T18:30:43.511Z"`
 * Example 2: `timestamp > "2012-04-23T18:25:43.511Z"`
      string filter = 3;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       A filtering expression to specify restrictions on returned metrics.
 The expression is a sequence of terms. Each term applies a restriction to
 the returned metrics. Use this expression to restrict results to a
 specific time range.

 Currently we expect only one types of fields:

 * `timestamp`: This can be specified twice, once with a
 less than operator and once with a greater than operator. The
 `timestamp` restriction should result in one, contiguous, valid,
 `timestamp` range.

 Some examples of valid filters expressions:

 * Example 1: `timestamp > "2012-04-23T18:25:43.511Z"
 timestamp < "2012-04-23T18:30:43.511Z"`
 * Example 2: `timestamp > "2012-04-23T18:25:43.511Z"`
      string filter = 3;
      Returns:
      The bytes for filter.