Class Report.Sort (0.11.0) 

public static final class Report.Sort extends GeneratedMessageV3 implements Report.SortOrBuilder

Represents a sorting in a report.

Protobuf type google.ads.admanager.v1.Report.Sort

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Report.Sort

Static Fields

DESCENDING_FIELD_NUMBER

public static final int DESCENDING_FIELD_NUMBER
Field Value
Type Description
int

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER
Field Value
Type Description
int

METRIC_VALUE_TYPE_FIELD_NUMBER

public static final int METRIC_VALUE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SLICE_FIELD_NUMBER

public static final int SLICE_FIELD_NUMBER
Field Value
Type Description
int

TIME_PERIOD_INDEX_FIELD_NUMBER

public static final int TIME_PERIOD_INDEX_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Report.Sort getDefaultInstance()
Returns
Type Description
Report.Sort

getDescriptor()

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

newBuilder()

public static Report.Sort.Builder newBuilder()
Returns
Type Description
Report.Sort.Builder

newBuilder(Report.Sort prototype)

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

parseDelimitedFrom(InputStream input)

public static Report.Sort parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Report.Sort
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Report.Sort parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Report.Sort
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Report.Sort parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Report.Sort
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Report.Sort parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Report.Sort
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Report.Sort parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Report.Sort
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Report.Sort> parser()
Returns
Type Description
Parser<Sort>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Report.Sort getDefaultInstanceForType()
Returns
Type Description
Report.Sort

getDescending()

public boolean getDescending()

Optional. The sort order. If true the sort will be descending.

bool descending = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The descending.

getField()

public Report.Field getField()

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Report.Field

The field.

getFieldOrBuilder()

public Report.FieldOrBuilder getFieldOrBuilder()

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Report.FieldOrBuilder

getMetricValueType()

public Report.MetricValueType getMetricValueType()

Optional. Use to specify which metric value type to sort on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Report.MetricValueType

The metricValueType.

getMetricValueTypeValue()

public int getMetricValueTypeValue()

Optional. Use to specify which metric value type to sort on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for metricValueType.

getParserForType()

public Parser<Report.Sort> getParserForType()
Returns
Type Description
Parser<Sort>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSlice()

public Report.Slice getSlice()

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.Report.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Report.Slice

The slice.

getSliceOrBuilder()

public Report.SliceOrBuilder getSliceOrBuilder()

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.Report.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Report.SliceOrBuilder

getTimePeriodIndex()

public int getTimePeriodIndex()

Optional. When using time period columns, use this to sort on a specific column.

optional int32 time_period_index = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The timePeriodIndex.

hasField()

public boolean hasField()

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the field field is set.

hasMetricValueType()

public boolean hasMetricValueType()

Optional. Use to specify which metric value type to sort on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the metricValueType field is set.

hasSlice()

public boolean hasSlice()

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.Report.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the slice field is set.

hasTimePeriodIndex()

public boolean hasTimePeriodIndex()

Optional. When using time period columns, use this to sort on a specific column.

optional int32 time_period_index = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the timePeriodIndex 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 Report.Sort.Builder newBuilderForType()
Returns
Type Description
Report.Sort.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Report.Sort.Builder toBuilder()
Returns
Type Description
Report.Sort.Builder

writeTo(CodedOutputStream output)

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