Class RemoveAllAudienceMembersRequest (0.20.0)

public final class RemoveAllAudienceMembersRequest extends GeneratedMessage implements RemoveAllAudienceMembersRequestOrBuilder

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

Protobuf type google.ads.datamanager.v1.RemoveAllAudienceMembersRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > RemoveAllAudienceMembersRequest

Static Fields

DESTINATIONS_FIELD_NUMBER

public static final int DESTINATIONS_FIELD_NUMBER
Field Value
Type Description
int

REMOVE_AS_OF_TIME_FIELD_NUMBER

public static final int REMOVE_AS_OF_TIME_FIELD_NUMBER
Field Value
Type Description
int

VALIDATE_ONLY_FIELD_NUMBER

public static final int VALIDATE_ONLY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RemoveAllAudienceMembersRequest getDefaultInstance()
Returns
Type Description
RemoveAllAudienceMembersRequest

getDescriptor()

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

newBuilder()

public static RemoveAllAudienceMembersRequest.Builder newBuilder()
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

newBuilder(RemoveAllAudienceMembersRequest prototype)

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

parseDelimitedFrom(InputStream input)

public static RemoveAllAudienceMembersRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RemoveAllAudienceMembersRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static RemoveAllAudienceMembersRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RemoveAllAudienceMembersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static RemoveAllAudienceMembersRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RemoveAllAudienceMembersRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static RemoveAllAudienceMembersRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RemoveAllAudienceMembersRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static RemoveAllAudienceMembersRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RemoveAllAudienceMembersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<RemoveAllAudienceMembersRequest> parser()
Returns
Type Description
Parser<RemoveAllAudienceMembersRequest>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public RemoveAllAudienceMembersRequest getDefaultInstanceForType()
Returns
Type Description
RemoveAllAudienceMembersRequest

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

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>

getParserForType()

public Parser<RemoveAllAudienceMembersRequest> getParserForType()
Returns
Type Description
Parser<RemoveAllAudienceMembersRequest>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RemoveAllAudienceMembersRequest.Builder newBuilderForType()
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RemoveAllAudienceMembersRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder
Overrides

toBuilder()

public RemoveAllAudienceMembersRequest.Builder toBuilder()
Returns
Type Description
RemoveAllAudienceMembersRequest.Builder

writeTo(CodedOutputStream output)

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