Class ListCompaniesRequest.Builder (0.58.0) 

public static final class ListCompaniesRequest.Builder extends GeneratedMessage.Builder<ListCompaniesRequest.Builder> implements ListCompaniesRequestOrBuilder

Request object for [ListCompanies][] method.

Protobuf type google.ads.admanager.v1.ListCompaniesRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListCompaniesRequest.Builder

Static Methods

getDescriptor()

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

Methods

build()

public ListCompaniesRequest build()
Returns
Type Description
ListCompaniesRequest

buildPartial()

public ListCompaniesRequest buildPartial()
Returns
Type Description
ListCompaniesRequest

clear()

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

clearFilter()

public ListCompaniesRequest.Builder clearFilter()

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Filterable fields:

  • address
  • comment
  • companyId
  • creditStatus
  • displayName
  • email
  • externalId
  • fax
  • name
  • phone
  • thirdPartyCompanyId
  • type
  • updateTime

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

Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.

clearOrderBy()

public ListCompaniesRequest.Builder clearOrderBy()

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.

clearPageSize()

public ListCompaniesRequest.Builder clearPageSize()

Optional. The maximum number of [Companies][] to return. The service may return fewer than this value. If unspecified, at most 50 [Companies][] will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.

clearPageToken()

public ListCompaniesRequest.Builder clearPageToken()

Optional. A page token, received from a previous [ListCompanies][] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [ListCompanies][] must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.

clearParent()

public ListCompaniesRequest.Builder clearParent()

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

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

Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.

clearSkip()

public ListCompaniesRequest.Builder clearSkip()

Optional. Number of individual resources to skip while paginating.

int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListCompaniesRequest getDefaultInstanceForType()
Returns
Type Description
ListCompaniesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Filterable fields:

  • address
  • comment
  • companyId
  • creditStatus
  • displayName
  • email
  • externalId
  • fax
  • name
  • phone
  • thirdPartyCompanyId
  • type
  • updateTime

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Filterable fields:

  • address
  • comment
  • companyId
  • creditStatus
  • displayName
  • email
  • externalId
  • fax
  • name
  • phone
  • thirdPartyCompanyId
  • type
  • updateTime

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

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. The maximum number of [Companies][] to return. The service may return fewer than this value. If unspecified, at most 50 [Companies][] will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token, received from a previous [ListCompanies][] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [ListCompanies][] must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A page token, received from a previous [ListCompanies][] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [ListCompanies][] must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent, which owns this collection of [Companies][]. 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 [Companies][]. Format: networks/{network_code}

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

Returns
Type Description
ByteString

The bytes for parent.

getSkip()

public int getSkip()

Optional. Number of individual resources to skip while paginating.

int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The skip.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListCompaniesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public ListCompaniesRequest.Builder setFilter(String value)

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Filterable fields:

  • address
  • comment
  • companyId
  • creditStatus
  • displayName
  • email
  • externalId
  • fax
  • name
  • phone
  • thirdPartyCompanyId
  • type
  • updateTime

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

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListCompaniesRequest.Builder setFilterBytes(ByteString value)

Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters

Filterable fields:

  • address
  • comment
  • companyId
  • creditStatus
  • displayName
  • email
  • externalId
  • fax
  • name
  • phone
  • thirdPartyCompanyId
  • type
  • updateTime

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

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListCompaniesRequest.Builder setOrderBy(String value)

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.
Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListCompaniesRequest.Builder setOrderByBytes(ByteString value)

Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.
Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListCompaniesRequest.Builder setPageSize(int value)

Optional. The maximum number of [Companies][] to return. The service may return fewer than this value. If unspecified, at most 50 [Companies][] will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListCompaniesRequest.Builder setPageToken(String value)

Optional. A page token, received from a previous [ListCompanies][] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [ListCompanies][] must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListCompaniesRequest.Builder setPageTokenBytes(ByteString value)

Optional. A page token, received from a previous [ListCompanies][] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [ListCompanies][] must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.

setParent(String value)

public ListCompaniesRequest.Builder setParent(String value)

Required. The parent, which owns this collection of [Companies][]. 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
ListCompaniesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListCompaniesRequest.Builder setParentBytes(ByteString value)

Required. The parent, which owns this collection of [Companies][]. 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
ListCompaniesRequest.Builder

This builder for chaining.

setSkip(int value)

public ListCompaniesRequest.Builder setSkip(int value)

Optional. Number of individual resources to skip while paginating.

int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The skip to set.
Returns
Type Description
ListCompaniesRequest.Builder

This builder for chaining.