Class BatchArchiveOrdersRequest.Builder (0.54.0)

public static final class BatchArchiveOrdersRequest.Builder extends GeneratedMessage.Builder<BatchArchiveOrdersRequest.Builder> implements BatchArchiveOrdersRequestOrBuilder

Request message for BatchArchiveOrders method.

Protobuf type google.ads.admanager.v1.BatchArchiveOrdersRequest

Static Methods

getDescriptor()

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

Methods

addAllNames(Iterable<String> values)

public BatchArchiveOrdersRequest.Builder addAllNames(Iterable<String> values)

Required. The resource names of the orders to archive. Format: networks/{network_code}/orders/{order_id}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The names to add.

Returns
Type Description
BatchArchiveOrdersRequest.Builder

This builder for chaining.

addNames(String value)

public BatchArchiveOrdersRequest.Builder addNames(String value)

Required. The resource names of the orders to archive. Format: networks/{network_code}/orders/{order_id}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The names to add.

Returns
Type Description
BatchArchiveOrdersRequest.Builder

This builder for chaining.

addNamesBytes(ByteString value)

public BatchArchiveOrdersRequest.Builder addNamesBytes(ByteString value)

Required. The resource names of the orders to archive. Format: networks/{network_code}/orders/{order_id}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the names to add.

Returns
Type Description
BatchArchiveOrdersRequest.Builder

This builder for chaining.

build()

public BatchArchiveOrdersRequest build()
Returns
Type Description
BatchArchiveOrdersRequest

buildPartial()

public BatchArchiveOrdersRequest buildPartial()
Returns
Type Description
BatchArchiveOrdersRequest

clear()

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

clearNames()

public BatchArchiveOrdersRequest.Builder clearNames()

Required. The resource names of the orders to archive. Format: networks/{network_code}/orders/{order_id}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
BatchArchiveOrdersRequest.Builder

This builder for chaining.

clearParent()

public BatchArchiveOrdersRequest.Builder clearParent()

Required. The parent, which owns this collection of Orders. Format: networks/{network_code}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
BatchArchiveOrdersRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public BatchArchiveOrdersRequest getDefaultInstanceForType()
Returns
Type Description
BatchArchiveOrdersRequest

getDescriptorForType()

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

getNames(int index)

public String getNames(int index)

Required. The resource names of the orders to archive. Format: networks/{network_code}/orders/{order_id}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The names at the given index.

getNamesBytes(int index)

public ByteString getNamesBytes(int index)

Required. The resource names of the orders to archive. Format: networks/{network_code}/orders/{order_id}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the names at the given index.

getNamesCount()

public int getNamesCount()

Required. The resource names of the orders to archive. Format: networks/{network_code}/orders/{order_id}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of names.

getNamesList()

public ProtocolStringList getNamesList()

Required. The resource names of the orders to archive. Format: networks/{network_code}/orders/{order_id}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the names.

getParent()

public String getParent()

Required. The parent, which owns this collection of Orders. Format: networks/{network_code}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent, which owns this collection of Orders. Format: networks/{network_code}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BatchArchiveOrdersRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setNames(int index, String value)

public BatchArchiveOrdersRequest.Builder setNames(int index, String value)

Required. The resource names of the orders to archive. Format: networks/{network_code}/orders/{order_id}

repeated string names = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The names to set.

Returns
Type Description
BatchArchiveOrdersRequest.Builder

This builder for chaining.

setParent(String value)

public BatchArchiveOrdersRequest.Builder setParent(String value)

Required. The parent, which owns this collection of Orders. Format: networks/{network_code}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
BatchArchiveOrdersRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public BatchArchiveOrdersRequest.Builder setParentBytes(ByteString value)

Required. The parent, which owns this collection of Orders. Format: networks/{network_code}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
BatchArchiveOrdersRequest.Builder

This builder for chaining.