Class ExportAnalyticsMetricsRequest.Builder (2.48.0)

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

Static 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
Overrides

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
Overrides

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
Overrides

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
Overrides

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
Overrides

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
Overrides

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
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExportAnalyticsMetricsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExportAnalyticsMetricsRequest.Builder
Overrides

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
Overrides

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 String

The 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 ByteString

The 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
Overrides

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 String

The 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 ByteString

The 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
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ExportAnalyticsMetricsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExportAnalyticsMetricsRequest.Builder
Overrides