Class IngestUsersRequest (0.20.0)

public final class IngestUsersRequest extends GeneratedMessage implements IngestUsersRequestOrBuilder

Request to upload users to the provided destinations.

Protobuf type google.ads.datamanager.v1.IngestUsersRequest

Static Fields

DESTINATIONS_FIELD_NUMBER

public static final int DESTINATIONS_FIELD_NUMBER
Field Value
Type Description
int

ENCODING_FIELD_NUMBER

public static final int ENCODING_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTION_INFO_FIELD_NUMBER

public static final int ENCRYPTION_INFO_FIELD_NUMBER
Field Value
Type Description
int

USERS_FIELD_NUMBER

public static final int USERS_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 IngestUsersRequest getDefaultInstance()
Returns
Type Description
IngestUsersRequest

getDescriptor()

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

newBuilder()

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

newBuilder(IngestUsersRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public IngestUsersRequest getDefaultInstanceForType()
Returns
Type Description
IngestUsersRequest

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

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.

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

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.

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

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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