Class ExportAnalyticsMetricsRequest (2.45.0)

public final class ExportAnalyticsMetricsRequest extends GeneratedMessageV3 implements ExportAnalyticsMetricsRequestOrBuilder

Request message for the ExportAnalyticsMetrics method.

Protobuf type google.cloud.retail.v2alpha.ExportAnalyticsMetricsRequest

Static Fields

CATALOG_FIELD_NUMBER

public static final int CATALOG_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_CONFIG_FIELD_NUMBER

public static final int OUTPUT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExportAnalyticsMetricsRequest getDefaultInstance()
Returns
Type Description
ExportAnalyticsMetricsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExportAnalyticsMetricsRequest.Builder newBuilder()
Returns
Type Description
ExportAnalyticsMetricsRequest.Builder

newBuilder(ExportAnalyticsMetricsRequest prototype)

public static ExportAnalyticsMetricsRequest.Builder newBuilder(ExportAnalyticsMetricsRequest prototype)
Parameter
Name Description
prototype ExportAnalyticsMetricsRequest
Returns
Type Description
ExportAnalyticsMetricsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ExportAnalyticsMetricsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportAnalyticsMetricsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportAnalyticsMetricsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportAnalyticsMetricsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExportAnalyticsMetricsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExportAnalyticsMetricsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExportAnalyticsMetricsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportAnalyticsMetricsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExportAnalyticsMetricsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExportAnalyticsMetricsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExportAnalyticsMetricsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportAnalyticsMetricsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExportAnalyticsMetricsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExportAnalyticsMetricsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportAnalyticsMetricsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportAnalyticsMetricsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExportAnalyticsMetricsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportAnalyticsMetricsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportAnalyticsMetricsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportAnalyticsMetricsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExportAnalyticsMetricsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExportAnalyticsMetricsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExportAnalyticsMetricsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportAnalyticsMetricsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExportAnalyticsMetricsRequest> parser()
Returns
Type Description
Parser<ExportAnalyticsMetricsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputConfig

The outputConfig.

getOutputConfigOrBuilder()

public OutputConfigOrBuilder getOutputConfigOrBuilder()

Required. The output location of the data.

.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputConfigOrBuilder

getParserForType()

public Parser<ExportAnalyticsMetricsRequest> getParserForType()
Returns
Type Description
Parser<ExportAnalyticsMetricsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasOutputConfig()

public boolean hasOutputConfig()

Required. The output location of the data.

.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the outputConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExportAnalyticsMetricsRequest.Builder newBuilderForType()
Returns
Type Description
ExportAnalyticsMetricsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExportAnalyticsMetricsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExportAnalyticsMetricsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExportAnalyticsMetricsRequest.Builder toBuilder()
Returns
Type Description
ExportAnalyticsMetricsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException