Class PrivateAuction.Builder (0.27.0)

public static final class PrivateAuction.Builder extends GeneratedMessageV3.Builder<PrivateAuction.Builder> implements PrivateAuctionOrBuilder

The PrivateAuction resource.

Protobuf type google.ads.admanager.v1.PrivateAuction

Static Methods

getDescriptor()

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

Methods

addAllSellerContactUsers(Iterable<String> values)

public PrivateAuction.Builder addAllSellerContactUsers(Iterable<String> values)

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
values Iterable<String>

The sellerContactUsers to add.

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PrivateAuction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PrivateAuction.Builder
Overrides

addSellerContactUsers(String value)

public PrivateAuction.Builder addSellerContactUsers(String value)

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
value String

The sellerContactUsers to add.

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

addSellerContactUsersBytes(ByteString value)

public PrivateAuction.Builder addSellerContactUsersBytes(ByteString value)

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
value ByteString

The bytes of the sellerContactUsers to add.

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

build()

public PrivateAuction build()
Returns
Type Description
PrivateAuction

buildPartial()

public PrivateAuction buildPartial()
Returns
Type Description
PrivateAuction

clear()

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

clearArchived()

public PrivateAuction.Builder clearArchived()

Output only. Whether the PrivateAuction is archived.

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

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

clearCreateTime()

public PrivateAuction.Builder clearCreateTime()

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

clearDescription()

public PrivateAuction.Builder clearDescription()

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

This builder for chaining.

clearDisplayName()

public PrivateAuction.Builder clearDisplayName()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PrivateAuction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PrivateAuction.Builder
Overrides

clearName()

public PrivateAuction.Builder clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PrivateAuction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PrivateAuction.Builder
Overrides

clearPrivateAuctionId()

public PrivateAuction.Builder clearPrivateAuctionId()

Output only. PrivateAuction ID.

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

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

clearSellerContactUsers()

public PrivateAuction.Builder clearSellerContactUsers()

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

This builder for chaining.

clearUpdateTime()

public PrivateAuction.Builder clearUpdateTime()

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

clone()

public PrivateAuction.Builder clone()
Returns
Type Description
PrivateAuction.Builder
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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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.

getDescriptorForType()

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

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.

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.

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public PrivateAuction.Builder mergeCreateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateAuction.Builder

mergeFrom(PrivateAuction other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PrivateAuction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PrivateAuction.Builder
Overrides

mergeUpdateTime(Timestamp value)

public PrivateAuction.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateAuction.Builder

setArchived(boolean value)

public PrivateAuction.Builder setArchived(boolean value)

Output only. Whether the PrivateAuction is archived.

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

Parameter
Name Description
value boolean

The archived to set.

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public PrivateAuction.Builder setCreateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateAuction.Builder

setCreateTime(Timestamp.Builder builderForValue)

public PrivateAuction.Builder setCreateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PrivateAuction.Builder

setDescription(String value)

public PrivateAuction.Builder setDescription(String value)

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

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

Parameter
Name Description
value String

The description to set.

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public PrivateAuction.Builder setDescriptionBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

setDisplayName(String value)

public PrivateAuction.Builder setDisplayName(String value)

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];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public PrivateAuction.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PrivateAuction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PrivateAuction.Builder
Overrides

setName(String value)

public PrivateAuction.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

setNameBytes(ByteString value)

public PrivateAuction.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

setPrivateAuctionId(long value)

public PrivateAuction.Builder setPrivateAuctionId(long value)

Output only. PrivateAuction ID.

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

Parameter
Name Description
value long

The privateAuctionId to set.

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PrivateAuction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PrivateAuction.Builder
Overrides

setSellerContactUsers(int index, String value)

public PrivateAuction.Builder setSellerContactUsers(int index, String value)

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) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The sellerContactUsers to set.

Returns
Type Description
PrivateAuction.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PrivateAuction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PrivateAuction.Builder
Overrides

setUpdateTime(Timestamp value)

public PrivateAuction.Builder setUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PrivateAuction.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public PrivateAuction.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PrivateAuction.Builder