com.google.cloud.retail.v2

Class ExportAnalyticsMetricsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2.ExportAnalyticsMetricsRequest

All Implemented Interfaces:

ExportAnalyticsMetricsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ExportAnalyticsMetricsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ExportAnalyticsMetricsRequestOrBuilder

 Request message for the `ExportAnalyticsMetrics` method.
 

Protobuf type google.cloud.retail.v2.ExportAnalyticsMetricsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExportAnalyticsMetricsRequest.Builder Request message for the `ExportAnalyticsMetrics` method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CATALOG_FIELD_NUMBER
static int	FILTER_FIELD_NUMBER
static int	OUTPUT_CONFIG_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCatalog() Required.
com.google.protobuf.ByteString	getCatalogBytes() Required.
static ExportAnalyticsMetricsRequest	getDefaultInstance()
ExportAnalyticsMetricsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<ExportAnalyticsMetricsRequest>	getParserForType()
int	getSerializedSize()
int	hashCode()
boolean	hasOutputConfig() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ExportAnalyticsMetricsRequest.Builder	newBuilder()
static ExportAnalyticsMetricsRequest.Builder	newBuilder(ExportAnalyticsMetricsRequest prototype)
ExportAnalyticsMetricsRequest.Builder	newBuilderForType()
protected ExportAnalyticsMetricsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ExportAnalyticsMetricsRequest	parseDelimitedFrom(InputStream input)
static ExportAnalyticsMetricsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportAnalyticsMetricsRequest	parseFrom(byte[] data)
static ExportAnalyticsMetricsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportAnalyticsMetricsRequest	parseFrom(ByteBuffer data)
static ExportAnalyticsMetricsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportAnalyticsMetricsRequest	parseFrom(com.google.protobuf.ByteString data)
static ExportAnalyticsMetricsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportAnalyticsMetricsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ExportAnalyticsMetricsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportAnalyticsMetricsRequest	parseFrom(InputStream input)
static ExportAnalyticsMetricsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ExportAnalyticsMetricsRequest>	parser()
ExportAnalyticsMetricsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CATALOG_FIELD_NUMBER

public static final int CATALOG_FIELD_NUMBER

See Also:

Constant Field Values

OUTPUT_CONFIG_FIELD_NUMBER

public static final int OUTPUT_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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];

Specified by:

getCatalog in interface ExportAnalyticsMetricsRequestOrBuilder

Returns:

The catalog.

getCatalogBytes

public 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];

Specified by:

getCatalogBytes in interface ExportAnalyticsMetricsRequestOrBuilder

Returns:

The bytes for catalog.

hasOutputConfig

public boolean hasOutputConfig()

 Required. The output location of the data.
 

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

Specified by:

hasOutputConfig in interface ExportAnalyticsMetricsRequestOrBuilder

Returns:

Whether the outputConfig field is set.

getOutputConfig

public OutputConfig getOutputConfig()

 Required. The output location of the data.
 

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

Specified by:

getOutputConfig in interface ExportAnalyticsMetricsRequestOrBuilder

Returns:

The outputConfig.

getOutputConfigOrBuilder

public OutputConfigOrBuilder getOutputConfigOrBuilder()

 Required. The output location of the data.
 

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

Specified by:

getOutputConfigOrBuilder in interface ExportAnalyticsMetricsRequestOrBuilder

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:

    * `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;

Specified by:

getFilter in interface ExportAnalyticsMetricsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public 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;

Specified by:

getFilterBytes in interface ExportAnalyticsMetricsRequestOrBuilder

Returns:

The bytes for filter.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 ExportAnalyticsMetricsRequest parseFrom(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportAnalyticsMetricsRequest parseFrom(ByteBuffer data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportAnalyticsMetricsRequest parseFrom(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportAnalyticsMetricsRequest parseFrom(com.google.protobuf.ByteString data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportAnalyticsMetricsRequest parseFrom(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportAnalyticsMetricsRequest parseFrom(byte[] data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportAnalyticsMetricsRequest parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static ExportAnalyticsMetricsRequest parseFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static ExportAnalyticsMetricsRequest parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static ExportAnalyticsMetricsRequest parseDelimitedFrom(InputStream input,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseFrom

public static ExportAnalyticsMetricsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static ExportAnalyticsMetricsRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

newBuilderForType

public ExportAnalyticsMetricsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ExportAnalyticsMetricsRequest.Builder newBuilder()

newBuilder

public static ExportAnalyticsMetricsRequest.Builder newBuilder(ExportAnalyticsMetricsRequest prototype)

toBuilder

public ExportAnalyticsMetricsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ExportAnalyticsMetricsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ExportAnalyticsMetricsRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ExportAnalyticsMetricsRequest> parser()

getParserForType

public com.google.protobuf.Parser<ExportAnalyticsMetricsRequest> 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.GeneratedMessageV3

getDefaultInstanceForType

public ExportAnalyticsMetricsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder