Class RemoveAllAudienceMembersRequest.Builder (0.20.0)

public static final class RemoveAllAudienceMembersRequest.Builder extends GeneratedMessage.Builder<RemoveAllAudienceMembersRequest.Builder> implements RemoveAllAudienceMembersRequestOrBuilder

Request to remove all users from an audience in the provided destinations. Returns a RemoveAllAudienceMembersResponse.

Protobuf type google.ads.datamanager.v1.RemoveAllAudienceMembersRequest

Static Methods

getDescriptor()

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

Methods

addAllDestinations(Iterable<? extends Destination> values)

public RemoveAllAudienceMembersRequest.Builder addAllDestinations(Iterable<? extends Destination> values)

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.ads.datamanager.v1.Destination>
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

addDestinations(Destination value)

public RemoveAllAudienceMembersRequest.Builder addDestinations(Destination value)

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Destination
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

addDestinations(Destination.Builder builderForValue)

public RemoveAllAudienceMembersRequest.Builder addDestinations(Destination.Builder builderForValue)

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Destination.Builder
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

addDestinations(int index, Destination value)

public RemoveAllAudienceMembersRequest.Builder addDestinations(int index, Destination value)

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value Destination
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

addDestinations(int index, Destination.Builder builderForValue)

public RemoveAllAudienceMembersRequest.Builder addDestinations(int index, Destination.Builder builderForValue)

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue Destination.Builder
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

addDestinationsBuilder()

public Destination.Builder addDestinationsBuilder()

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Destination.Builder

addDestinationsBuilder(int index)

public Destination.Builder addDestinationsBuilder(int index)

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Destination.Builder

build()

public RemoveAllAudienceMembersRequest build()
Returns
Type Description
RemoveAllAudienceMembersRequest

buildPartial()

public RemoveAllAudienceMembersRequest buildPartial()
Returns
Type Description
RemoveAllAudienceMembersRequest

clear()

public RemoveAllAudienceMembersRequest.Builder clear()
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder
Overrides

clearDestinations()

public RemoveAllAudienceMembersRequest.Builder clearDestinations()

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

clearRemoveAsOfTime()

public RemoveAllAudienceMembersRequest.Builder clearRemoveAsOfTime()

Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time. The remove as of time must not be in the future.

.google.protobuf.Timestamp remove_as_of_time = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

clearValidateOnly()

public RemoveAllAudienceMembersRequest.Builder clearValidateOnly()

Optional. For testing purposes. If true, the request is validated but not executed. Only errors are returned, not results.

bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public RemoveAllAudienceMembersRequest getDefaultInstanceForType()
Returns
Type Description
RemoveAllAudienceMembersRequest

getDescriptorForType()

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

getDestinations(int index)

public Destination getDestinations(int index)

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Destination

getDestinationsBuilder(int index)

public Destination.Builder getDestinationsBuilder(int index)

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Destination.Builder

getDestinationsBuilderList()

public List<Destination.Builder> getDestinationsBuilderList()

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getDestinationsCount()

public int getDestinationsCount()

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getDestinationsList()

public List<Destination> getDestinationsList()

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Destination>

getDestinationsOrBuilder(int index)

public DestinationOrBuilder getDestinationsOrBuilder(int index)

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
DestinationOrBuilder

getDestinationsOrBuilderList()

public List<? extends DestinationOrBuilder> getDestinationsOrBuilderList()

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.ads.datamanager.v1.DestinationOrBuilder>

getRemoveAsOfTime()

public Timestamp getRemoveAsOfTime()

Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time. The remove as of time must not be in the future.

.google.protobuf.Timestamp remove_as_of_time = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The removeAsOfTime.

getRemoveAsOfTimeBuilder()

public Timestamp.Builder getRemoveAsOfTimeBuilder()

Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time. The remove as of time must not be in the future.

.google.protobuf.Timestamp remove_as_of_time = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getRemoveAsOfTimeOrBuilder()

public TimestampOrBuilder getRemoveAsOfTimeOrBuilder()

Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time. The remove as of time must not be in the future.

.google.protobuf.Timestamp remove_as_of_time = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getValidateOnly()

public boolean getValidateOnly()

Optional. For testing purposes. If true, the request is validated but not executed. Only errors are returned, not results.

bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The validateOnly.

hasRemoveAsOfTime()

public boolean hasRemoveAsOfTime()

Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time. The remove as of time must not be in the future.

.google.protobuf.Timestamp remove_as_of_time = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the removeAsOfTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RemoveAllAudienceMembersRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeRemoveAsOfTime(Timestamp value)

public RemoveAllAudienceMembersRequest.Builder mergeRemoveAsOfTime(Timestamp value)

Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time. The remove as of time must not be in the future.

.google.protobuf.Timestamp remove_as_of_time = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Timestamp
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

removeDestinations(int index)

public RemoveAllAudienceMembersRequest.Builder removeDestinations(int index)

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

setDestinations(int index, Destination value)

public RemoveAllAudienceMembersRequest.Builder setDestinations(int index, Destination value)

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value Destination
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

setDestinations(int index, Destination.Builder builderForValue)

public RemoveAllAudienceMembersRequest.Builder setDestinations(int index, Destination.Builder builderForValue)

Required. The list of destinations to remove the users from.

repeated .google.ads.datamanager.v1.Destination destinations = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue Destination.Builder
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

setRemoveAsOfTime(Timestamp value)

public RemoveAllAudienceMembersRequest.Builder setRemoveAsOfTime(Timestamp value)

Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time. The remove as of time must not be in the future.

.google.protobuf.Timestamp remove_as_of_time = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Timestamp
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

setRemoveAsOfTime(Timestamp.Builder builderForValue)

public RemoveAllAudienceMembersRequest.Builder setRemoveAsOfTime(Timestamp.Builder builderForValue)

Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time. The remove as of time must not be in the future.

.google.protobuf.Timestamp remove_as_of_time = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

setValidateOnly(boolean value)

public RemoveAllAudienceMembersRequest.Builder setValidateOnly(boolean value)

Optional. For testing purposes. If true, the request is validated but not executed. Only errors are returned, not results.

bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The validateOnly to set.

Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

This builder for chaining.