Class PrivateAuction (0.27.0)

public final class PrivateAuction extends GeneratedMessageV3 implements PrivateAuctionOrBuilder

The PrivateAuction resource.

Protobuf type google.ads.admanager.v1.PrivateAuction

Static Fields

ARCHIVED_FIELD_NUMBER

public static final int ARCHIVED_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PRIVATE_AUCTION_ID_FIELD_NUMBER

public static final int PRIVATE_AUCTION_ID_FIELD_NUMBER
Field Value
Type Description
int

SELLER_CONTACT_USERS_FIELD_NUMBER

public static final int SELLER_CONTACT_USERS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PrivateAuction getDefaultInstance()
Returns
Type Description
PrivateAuction

getDescriptor()

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

newBuilder()

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

newBuilder(PrivateAuction prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getArchived()

public boolean getArchived()

Output only. Whether the PrivateAuction is archived.

optional bool archived = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The archived.

getCreateTime()

public Timestamp getCreateTime()

Output only. The instant at which the PrivateAuction was created.

optional .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The instant at which the PrivateAuction was created.

optional .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public PrivateAuction getDefaultInstanceForType()
Returns
Type Description
PrivateAuction

getDescription()

public String getDescription()

Optional. Description of the PrivateAuction. This attribute has a maximum length of 4096 bytes.

optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the PrivateAuction. This attribute has a maximum length of 4096 bytes.

optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. Display name of the PrivateAuction. This attribute has a maximum length of 255 bytes.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Display name of the PrivateAuction. This attribute has a maximum length of 255 bytes.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. The resource name of the PrivateAuction. Format: networks/{network_code}/privateAuctions/{private_auction_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the PrivateAuction. Format: networks/{network_code}/privateAuctions/{private_auction_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPrivateAuctionId()

public long getPrivateAuctionId()

Output only. PrivateAuction ID.

optional int64 private_auction_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The privateAuctionId.

getSellerContactUsers(int index)

public String getSellerContactUsers(int index)

Optional. The resource names of the seller contact users associated with this PrivateAuction. Format: networks/{network_code}/users/{user_id}

repeated string seller_contact_users = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The sellerContactUsers at the given index.

getSellerContactUsersBytes(int index)

public ByteString getSellerContactUsersBytes(int index)

Optional. The resource names of the seller contact users associated with this PrivateAuction. Format: networks/{network_code}/users/{user_id}

repeated string seller_contact_users = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the sellerContactUsers at the given index.

getSellerContactUsersCount()

public int getSellerContactUsersCount()

Optional. The resource names of the seller contact users associated with this PrivateAuction. Format: networks/{network_code}/users/{user_id}

repeated string seller_contact_users = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of sellerContactUsers.

getSellerContactUsersList()

public ProtocolStringList getSellerContactUsersList()

Optional. The resource names of the seller contact users associated with this PrivateAuction. Format: networks/{network_code}/users/{user_id}

repeated string seller_contact_users = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the sellerContactUsers.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The instant at which the PrivateAuction was last updated.

optional .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The instant at which the PrivateAuction was last updated.

optional .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasArchived()

public boolean hasArchived()

Output only. Whether the PrivateAuction is archived.

optional bool archived = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the archived field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The instant at which the PrivateAuction was created.

optional .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDescription()

public boolean hasDescription()

Optional. Description of the PrivateAuction. This attribute has a maximum length of 4096 bytes.

optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the description field is set.

hasDisplayName()

public boolean hasDisplayName()

Required. Display name of the PrivateAuction. This attribute has a maximum length of 255 bytes.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the displayName field is set.

hasPrivateAuctionId()

public boolean hasPrivateAuctionId()

Output only. PrivateAuction ID.

optional int64 private_auction_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the privateAuctionId field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The instant at which the PrivateAuction was last updated.

optional .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PrivateAuction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PrivateAuction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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