- 2.80.0 (latest)
 - 2.78.0
 - 2.77.0
 - 2.76.0
 - 2.75.0
 - 2.74.0
 - 2.72.0
 - 2.70.0
 - 2.69.0
 - 2.66.0
 - 2.65.0
 - 2.64.0
 - 2.62.0
 - 2.61.0
 - 2.60.0
 - 2.59.0
 - 2.58.0
 - 2.57.0
 - 2.56.0
 - 2.55.0
 - 2.54.0
 - 2.53.0
 - 2.51.0
 - 2.50.0
 - 2.49.0
 - 2.48.0
 - 2.47.0
 - 2.46.0
 - 2.45.0
 - 2.44.0
 - 2.43.0
 - 2.42.0
 - 2.41.0
 - 2.39.0
 - 2.38.0
 - 2.37.0
 - 2.36.0
 - 2.35.0
 - 2.34.0
 - 2.33.0
 - 2.32.0
 - 2.31.0
 - 2.30.0
 - 2.29.0
 - 2.26.0
 - 2.25.0
 - 2.24.0
 - 2.23.0
 - 2.22.0
 - 2.21.0
 - 2.20.0
 - 2.19.0
 - 2.18.0
 - 2.17.0
 - 2.16.0
 - 2.15.0
 - 2.14.0
 - 2.13.0
 - 2.11.0
 - 2.10.0
 - 2.9.0
 - 2.8.0
 - 2.7.0
 - 2.6.0
 - 2.5.1
 - 2.4.0
 - 2.3.0
 - 2.2.3
 - 2.1.0
 - 2.0.19
 
public static final class ExportAnalyticsMetricsRequest.Builder extends GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder> implements ExportAnalyticsMetricsRequestOrBuilder Request message for the ExportAnalyticsMetrics method.
 Protobuf type google.cloud.retail.v2.ExportAnalyticsMetricsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExportAnalyticsMetricsRequest.BuilderImplements
ExportAnalyticsMetricsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExportAnalyticsMetricsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
build()
public ExportAnalyticsMetricsRequest build()| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest | 
        |
buildPartial()
public ExportAnalyticsMetricsRequest buildPartial()| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest | 
        |
clear()
public ExportAnalyticsMetricsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
clearCatalog()
public ExportAnalyticsMetricsRequest.Builder clearCatalog() Required. Full resource name of the parent catalog.
 Expected format: projects/*/locations/*/catalogs/*
 string catalog = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        This builder for chaining.  | 
      
clearField(Descriptors.FieldDescriptor field)
public ExportAnalyticsMetricsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
clearFilter()
public ExportAnalyticsMetricsRequest.Builder clearFilter()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:
* <code>timestamp</code>: This can be specified twice, once with a
  less than operator and once with a greater than operator. The
  <code>timestamp</code> restriction should result in one, contiguous, valid,
  <code>timestamp</code> 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 | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        This builder for chaining.  | 
      
clearOneof(Descriptors.OneofDescriptor oneof)
public ExportAnalyticsMetricsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description | 
oneof | 
        OneofDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
clearOutputConfig()
public ExportAnalyticsMetricsRequest.Builder clearOutputConfig()Required. The output location of the data.
 
 .google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
clone()
public ExportAnalyticsMetricsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
getCatalog()
public String getCatalog() Required. Full resource name of the parent catalog.
 Expected format: projects/*/locations/*/catalogs/*
 string catalog = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The catalog.  | 
      
getCatalogBytes()
public ByteString getCatalogBytes() Required. Full resource name of the parent catalog.
 Expected format: projects/*/locations/*/catalogs/*
 string catalog = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for catalog.  | 
      
getDefaultInstanceForType()
public ExportAnalyticsMetricsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest | 
        |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
getFilter()
public 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:
* <code>timestamp</code>: This can be specified twice, once with a
  less than operator and once with a greater than operator. The
  <code>timestamp</code> restriction should result in one, contiguous, valid,
  <code>timestamp</code> 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 | |
|---|---|
| Type | Description | 
String | 
        The filter.  | 
      
getFilterBytes()
public 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:
* <code>timestamp</code>: This can be specified twice, once with a
  less than operator and once with a greater than operator. The
  <code>timestamp</code> restriction should result in one, contiguous, valid,
  <code>timestamp</code> 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 | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for filter.  | 
      
getOutputConfig()
public OutputConfig getOutputConfig()Required. The output location of the data.
 
 .google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
OutputConfig | 
        The outputConfig.  | 
      
getOutputConfigBuilder()
public OutputConfig.Builder getOutputConfigBuilder()Required. The output location of the data.
 
 .google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
OutputConfig.Builder | 
        |
getOutputConfigOrBuilder()
public OutputConfigOrBuilder getOutputConfigOrBuilder()Required. The output location of the data.
 
 .google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
OutputConfigOrBuilder | 
        |
hasOutputConfig()
public boolean hasOutputConfig()Required. The output location of the data.
 
 .google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the outputConfig field is set.  | 
      
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description | 
FieldAccessorTable | 
        |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
mergeFrom(ExportAnalyticsMetricsRequest other)
public ExportAnalyticsMetricsRequest.Builder mergeFrom(ExportAnalyticsMetricsRequest other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        ExportAnalyticsMetricsRequest | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExportAnalyticsMetricsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description | 
input | 
        CodedInputStream | 
      
extensionRegistry | 
        ExtensionRegistryLite | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
| Exceptions | |
|---|---|
| Type | Description | 
IOException | 
        |
mergeFrom(Message other)
public ExportAnalyticsMetricsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        Message | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
mergeOutputConfig(OutputConfig value)
public ExportAnalyticsMetricsRequest.Builder mergeOutputConfig(OutputConfig value)Required. The output location of the data.
 
 .google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        OutputConfig | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExportAnalyticsMetricsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
setCatalog(String value)
public ExportAnalyticsMetricsRequest.Builder setCatalog(String value) Required. Full resource name of the parent catalog.
 Expected format: projects/*/locations/*/catalogs/*
 string catalog = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe catalog to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        This builder for chaining.  | 
      
setCatalogBytes(ByteString value)
public ExportAnalyticsMetricsRequest.Builder setCatalogBytes(ByteString value) Required. Full resource name of the parent catalog.
 Expected format: projects/*/locations/*/catalogs/*
 string catalog = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe bytes for catalog to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        This builder for chaining.  | 
      
setField(Descriptors.FieldDescriptor field, Object value)
public ExportAnalyticsMetricsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
setFilter(String value)
public ExportAnalyticsMetricsRequest.Builder setFilter(String value)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:
* <code>timestamp</code>: This can be specified twice, once with a
  less than operator and once with a greater than operator. The
  <code>timestamp</code> restriction should result in one, contiguous, valid,
  <code>timestamp</code> 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;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe filter to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        This builder for chaining.  | 
      
setFilterBytes(ByteString value)
public ExportAnalyticsMetricsRequest.Builder setFilterBytes(ByteString value)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:
* <code>timestamp</code>: This can be specified twice, once with a
  less than operator and once with a greater than operator. The
  <code>timestamp</code> restriction should result in one, contiguous, valid,
  <code>timestamp</code> 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;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe bytes for filter to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        This builder for chaining.  | 
      
setOutputConfig(OutputConfig value)
public ExportAnalyticsMetricsRequest.Builder setOutputConfig(OutputConfig value)Required. The output location of the data.
 
 .google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        OutputConfig | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
setOutputConfig(OutputConfig.Builder builderForValue)
public ExportAnalyticsMetricsRequest.Builder setOutputConfig(OutputConfig.Builder builderForValue)Required. The output location of the data.
 
 .google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        OutputConfig.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExportAnalyticsMetricsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
index | 
        int | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |
setUnknownFields(UnknownFieldSet unknownFields)
public final ExportAnalyticsMetricsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
ExportAnalyticsMetricsRequest.Builder | 
        |