Class ReportDefinition.Flag (0.39.0)

public static final class ReportDefinition.Flag extends GeneratedMessageV3 implements ReportDefinition.FlagOrBuilder

A flag for a report. Flags are used show if certain thresholds are met. Result rows that match the filter will have the corresponding MetricValueGroup.flagValues index set to true. For more information about flags see: https://support.google.com/admanager/answer/15079975

Protobuf type google.ads.admanager.v1.ReportDefinition.Flag

Static Fields

FILTERS_FIELD_NUMBER

public static final int FILTERS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReportDefinition.Flag getDefaultInstance()
Returns
Type Description
ReportDefinition.Flag

getDescriptor()

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

newBuilder()

public static ReportDefinition.Flag.Builder newBuilder()
Returns
Type Description
ReportDefinition.Flag.Builder

newBuilder(ReportDefinition.Flag prototype)

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

parseDelimitedFrom(InputStream input)

public static ReportDefinition.Flag parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReportDefinition.Flag
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ReportDefinition.Flag parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ReportDefinition.Flag
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ReportDefinition.Flag parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReportDefinition.Flag
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ReportDefinition.Flag parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReportDefinition.Flag
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ReportDefinition.Flag parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReportDefinition.Flag
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ReportDefinition.Flag> parser()
Returns
Type Description
Parser<Flag>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ReportDefinition.Flag getDefaultInstanceForType()
Returns
Type Description
ReportDefinition.Flag

getFilters(int index)

public ReportDefinition.Filter getFilters(int index)

Required. Filters to apply for the flag.

repeated .google.ads.admanager.v1.ReportDefinition.Filter filters = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ReportDefinition.Filter

getFiltersCount()

public int getFiltersCount()

Required. Filters to apply for the flag.

repeated .google.ads.admanager.v1.ReportDefinition.Filter filters = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getFiltersList()

public List<ReportDefinition.Filter> getFiltersList()

Required. Filters to apply for the flag.

repeated .google.ads.admanager.v1.ReportDefinition.Filter filters = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Filter>

getFiltersOrBuilder(int index)

public ReportDefinition.FilterOrBuilder getFiltersOrBuilder(int index)

Required. Filters to apply for the flag.

repeated .google.ads.admanager.v1.ReportDefinition.Filter filters = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ReportDefinition.FilterOrBuilder

getFiltersOrBuilderList()

public List<? extends ReportDefinition.FilterOrBuilder> getFiltersOrBuilderList()

Required. Filters to apply for the flag.

repeated .google.ads.admanager.v1.ReportDefinition.Filter filters = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.ReportDefinition.FilterOrBuilder>

getName()

public String getName()

Optional. Name of the flag. The flag names RED, YELLOW, GREEN, BLUE, PURPLE, and GREY correspond to the colored flags that appear in the UI. The UI won't display flags with other names, but they are available for use by API clients.

string name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Optional. Name of the flag. The flag names RED, YELLOW, GREEN, BLUE, PURPLE, and GREY correspond to the colored flags that appear in the UI. The UI won't display flags with other names, but they are available for use by API clients.

string name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<ReportDefinition.Flag> getParserForType()
Returns
Type Description
Parser<Flag>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 ReportDefinition.Flag.Builder newBuilderForType()
Returns
Type Description
ReportDefinition.Flag.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ReportDefinition.Flag.Builder toBuilder()
Returns
Type Description
ReportDefinition.Flag.Builder

writeTo(CodedOutputStream output)

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