Class ReportDefinition.Flag.Builder (0.39.0)

public static final class ReportDefinition.Flag.Builder extends GeneratedMessageV3.Builder<ReportDefinition.Flag.Builder> 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 Methods

getDescriptor()

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

Methods

addAllFilters(Iterable<? extends ReportDefinition.Filter> values)

public ReportDefinition.Flag.Builder addAllFilters(Iterable<? extends ReportDefinition.Filter> values)

Required. Filters to apply for the flag.

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

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.ReportDefinition.Filter>
Returns
Type Description
ReportDefinition.Flag.Builder

addFilters(ReportDefinition.Filter value)

public ReportDefinition.Flag.Builder addFilters(ReportDefinition.Filter value)

Required. Filters to apply for the flag.

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

Parameter
Name Description
value ReportDefinition.Filter
Returns
Type Description
ReportDefinition.Flag.Builder

addFilters(ReportDefinition.Filter.Builder builderForValue)

public ReportDefinition.Flag.Builder addFilters(ReportDefinition.Filter.Builder builderForValue)

Required. Filters to apply for the flag.

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

Parameter
Name Description
builderForValue ReportDefinition.Filter.Builder
Returns
Type Description
ReportDefinition.Flag.Builder

addFilters(int index, ReportDefinition.Filter value)

public ReportDefinition.Flag.Builder addFilters(int index, ReportDefinition.Filter value)

Required. Filters to apply for the flag.

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

Parameters
Name Description
index int
value ReportDefinition.Filter
Returns
Type Description
ReportDefinition.Flag.Builder

addFilters(int index, ReportDefinition.Filter.Builder builderForValue)

public ReportDefinition.Flag.Builder addFilters(int index, ReportDefinition.Filter.Builder builderForValue)

Required. Filters to apply for the flag.

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

Parameters
Name Description
index int
builderForValue ReportDefinition.Filter.Builder
Returns
Type Description
ReportDefinition.Flag.Builder

addFiltersBuilder()

public ReportDefinition.Filter.Builder addFiltersBuilder()

Required. Filters to apply for the flag.

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

Returns
Type Description
ReportDefinition.Filter.Builder

addFiltersBuilder(int index)

public ReportDefinition.Filter.Builder addFiltersBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReportDefinition.Flag.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReportDefinition.Flag.Builder
Overrides

build()

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

buildPartial()

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

clear()

public ReportDefinition.Flag.Builder clear()
Returns
Type Description
ReportDefinition.Flag.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ReportDefinition.Flag.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ReportDefinition.Flag.Builder
Overrides

clearFilters()

public ReportDefinition.Flag.Builder clearFilters()

Required. Filters to apply for the flag.

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

Returns
Type Description
ReportDefinition.Flag.Builder

clearName()

public ReportDefinition.Flag.Builder clearName()

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
ReportDefinition.Flag.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ReportDefinition.Flag.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ReportDefinition.Flag.Builder
Overrides

clone()

public ReportDefinition.Flag.Builder clone()
Returns
Type Description
ReportDefinition.Flag.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getFiltersBuilder(int index)

public ReportDefinition.Filter.Builder getFiltersBuilder(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.Builder

getFiltersBuilderList()

public List<ReportDefinition.Filter.Builder> getFiltersBuilderList()

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<Builder>

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ReportDefinition.Flag other)

public ReportDefinition.Flag.Builder mergeFrom(ReportDefinition.Flag other)
Parameter
Name Description
other ReportDefinition.Flag
Returns
Type Description
ReportDefinition.Flag.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReportDefinition.Flag.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportDefinition.Flag.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReportDefinition.Flag.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReportDefinition.Flag.Builder
Overrides

removeFilters(int index)

public ReportDefinition.Flag.Builder removeFilters(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.Flag.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ReportDefinition.Flag.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReportDefinition.Flag.Builder
Overrides

setFilters(int index, ReportDefinition.Filter value)

public ReportDefinition.Flag.Builder setFilters(int index, ReportDefinition.Filter value)

Required. Filters to apply for the flag.

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

Parameters
Name Description
index int
value ReportDefinition.Filter
Returns
Type Description
ReportDefinition.Flag.Builder

setFilters(int index, ReportDefinition.Filter.Builder builderForValue)

public ReportDefinition.Flag.Builder setFilters(int index, ReportDefinition.Filter.Builder builderForValue)

Required. Filters to apply for the flag.

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

Parameters
Name Description
index int
builderForValue ReportDefinition.Filter.Builder
Returns
Type Description
ReportDefinition.Flag.Builder

setName(String value)

public ReportDefinition.Flag.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ReportDefinition.Flag.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ReportDefinition.Flag.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ReportDefinition.Flag.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ReportDefinition.Flag.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ReportDefinition.Flag.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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