Class IngestUsersRequest.Builder (0.20.0)

public static final class IngestUsersRequest.Builder extends GeneratedMessage.Builder<IngestUsersRequest.Builder> implements IngestUsersRequestOrBuilder

Request to upload users to the provided destinations.

Protobuf type google.ads.datamanager.v1.IngestUsersRequest

Static Methods

getDescriptor()

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

Methods

addAllDestinations(Iterable<? extends Destination> values)

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

Required. The list of possible ingestion destinations.

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

addAllUsers(Iterable<? extends User> values)

public IngestUsersRequest.Builder addAllUsers(Iterable<? extends User> values)

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

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

addDestinations(Destination value)

public IngestUsersRequest.Builder addDestinations(Destination value)

Required. The list of possible ingestion destinations.

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

Parameter
Name Description
value Destination
Returns
Type Description
IngestUsersRequest.Builder

addDestinations(Destination.Builder builderForValue)

public IngestUsersRequest.Builder addDestinations(Destination.Builder builderForValue)

Required. The list of possible ingestion destinations.

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

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

addDestinations(int index, Destination value)

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

Required. The list of possible ingestion destinations.

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

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

addDestinations(int index, Destination.Builder builderForValue)

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

Required. The list of possible ingestion destinations.

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

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

addDestinationsBuilder()

public Destination.Builder addDestinationsBuilder()

Required. The list of possible ingestion destinations.

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 possible ingestion destinations.

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

Parameter
Name Description
index int
Returns
Type Description
Destination.Builder

addUsers(User value)

public IngestUsersRequest.Builder addUsers(User value)

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value User
Returns
Type Description
IngestUsersRequest.Builder

addUsers(User.Builder builderForValue)

public IngestUsersRequest.Builder addUsers(User.Builder builderForValue)

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue User.Builder
Returns
Type Description
IngestUsersRequest.Builder

addUsers(int index, User value)

public IngestUsersRequest.Builder addUsers(int index, User value)

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value User
Returns
Type Description
IngestUsersRequest.Builder

addUsers(int index, User.Builder builderForValue)

public IngestUsersRequest.Builder addUsers(int index, User.Builder builderForValue)

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue User.Builder
Returns
Type Description
IngestUsersRequest.Builder

addUsersBuilder()

public User.Builder addUsersBuilder()

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
User.Builder

addUsersBuilder(int index)

public User.Builder addUsersBuilder(int index)

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
User.Builder

build()

public IngestUsersRequest build()
Returns
Type Description
IngestUsersRequest

buildPartial()

public IngestUsersRequest buildPartial()
Returns
Type Description
IngestUsersRequest

clear()

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

clearDestinations()

public IngestUsersRequest.Builder clearDestinations()

Required. The list of possible ingestion destinations.

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

Returns
Type Description
IngestUsersRequest.Builder

clearEncoding()

public IngestUsersRequest.Builder clearEncoding()

Required. The encoding type of the user identifiers. For encrypted user identifiers, this only applies to the outer encoding.

.google.ads.datamanager.v1.Encoding encoding = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IngestUsersRequest.Builder

This builder for chaining.

clearEncryptionInfo()

public IngestUsersRequest.Builder clearEncryptionInfo()

Optional. Encryption information about encryption keys which are used to encrypt the data.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IngestUsersRequest.Builder

clearUsers()

public IngestUsersRequest.Builder clearUsers()

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IngestUsersRequest.Builder

clearValidateOnly()

public IngestUsersRequest.Builder clearValidateOnly()

Optional. If true, the request is validated but not executed.

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

Returns
Type Description
IngestUsersRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public IngestUsersRequest getDefaultInstanceForType()
Returns
Type Description
IngestUsersRequest

getDescriptorForType()

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

getDestinations(int index)

public Destination getDestinations(int index)

Required. The list of possible ingestion destinations.

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 possible ingestion destinations.

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 possible ingestion destinations.

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 possible ingestion destinations.

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 possible ingestion destinations.

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 possible ingestion destinations.

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 possible ingestion destinations.

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

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

getEncoding()

public Encoding getEncoding()

Required. The encoding type of the user identifiers. For encrypted user identifiers, this only applies to the outer encoding.

.google.ads.datamanager.v1.Encoding encoding = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Encoding

The encoding.

getEncodingValue()

public int getEncodingValue()

Required. The encoding type of the user identifiers. For encrypted user identifiers, this only applies to the outer encoding.

.google.ads.datamanager.v1.Encoding encoding = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for encoding.

getEncryptionInfo()

public EncryptionInfo getEncryptionInfo()

Optional. Encryption information about encryption keys which are used to encrypt the data.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionInfo

The encryptionInfo.

getEncryptionInfoBuilder()

public EncryptionInfo.Builder getEncryptionInfoBuilder()

Optional. Encryption information about encryption keys which are used to encrypt the data.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionInfo.Builder

getEncryptionInfoOrBuilder()

public EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()

Optional. Encryption information about encryption keys which are used to encrypt the data.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionInfoOrBuilder

getUsers(int index)

public User getUsers(int index)

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
User

getUsersBuilder(int index)

public User.Builder getUsersBuilder(int index)

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
User.Builder

getUsersBuilderList()

public List<User.Builder> getUsersBuilderList()

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getUsersCount()

public int getUsersCount()

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getUsersList()

public List<User> getUsersList()

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<User>

getUsersOrBuilder(int index)

public UserOrBuilder getUsersOrBuilder(int index)

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
UserOrBuilder

getUsersOrBuilderList()

public List<? extends UserOrBuilder> getUsersOrBuilderList()

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

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

getValidateOnly()

public boolean getValidateOnly()

Optional. If true, the request is validated but not executed.

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

Returns
Type Description
boolean

The validateOnly.

hasEncryptionInfo()

public boolean hasEncryptionInfo()

Optional. Encryption information about encryption keys which are used to encrypt the data.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the encryptionInfo field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEncryptionInfo(EncryptionInfo value)

public IngestUsersRequest.Builder mergeEncryptionInfo(EncryptionInfo value)

Optional. Encryption information about encryption keys which are used to encrypt the data.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EncryptionInfo
Returns
Type Description
IngestUsersRequest.Builder

mergeFrom(IngestUsersRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

removeDestinations(int index)

public IngestUsersRequest.Builder removeDestinations(int index)

Required. The list of possible ingestion destinations.

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

Parameter
Name Description
index int
Returns
Type Description
IngestUsersRequest.Builder

removeUsers(int index)

public IngestUsersRequest.Builder removeUsers(int index)

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
IngestUsersRequest.Builder

setDestinations(int index, Destination value)

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

Required. The list of possible ingestion destinations.

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

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

setDestinations(int index, Destination.Builder builderForValue)

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

Required. The list of possible ingestion destinations.

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

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

setEncoding(Encoding value)

public IngestUsersRequest.Builder setEncoding(Encoding value)

Required. The encoding type of the user identifiers. For encrypted user identifiers, this only applies to the outer encoding.

.google.ads.datamanager.v1.Encoding encoding = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Encoding

The encoding to set.

Returns
Type Description
IngestUsersRequest.Builder

This builder for chaining.

setEncodingValue(int value)

public IngestUsersRequest.Builder setEncodingValue(int value)

Required. The encoding type of the user identifiers. For encrypted user identifiers, this only applies to the outer encoding.

.google.ads.datamanager.v1.Encoding encoding = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for encoding to set.

Returns
Type Description
IngestUsersRequest.Builder

This builder for chaining.

setEncryptionInfo(EncryptionInfo value)

public IngestUsersRequest.Builder setEncryptionInfo(EncryptionInfo value)

Optional. Encryption information about encryption keys which are used to encrypt the data.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EncryptionInfo
Returns
Type Description
IngestUsersRequest.Builder

setEncryptionInfo(EncryptionInfo.Builder builderForValue)

public IngestUsersRequest.Builder setEncryptionInfo(EncryptionInfo.Builder builderForValue)

Optional. Encryption information about encryption keys which are used to encrypt the data.

.google.ads.datamanager.v1.EncryptionInfo encryption_info = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue EncryptionInfo.Builder
Returns
Type Description
IngestUsersRequest.Builder

setUsers(int index, User value)

public IngestUsersRequest.Builder setUsers(int index, User value)

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value User
Returns
Type Description
IngestUsersRequest.Builder

setUsers(int index, User.Builder builderForValue)

public IngestUsersRequest.Builder setUsers(int index, User.Builder builderForValue)

Required. The list of users to ingest.

repeated .google.ads.datamanager.v1.User users = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue User.Builder
Returns
Type Description
IngestUsersRequest.Builder

setValidateOnly(boolean value)

public IngestUsersRequest.Builder setValidateOnly(boolean value)

Optional. If true, the request is validated but not executed.

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

Parameter
Name Description
value boolean

The validateOnly to set.

Returns
Type Description
IngestUsersRequest.Builder

This builder for chaining.