Class ListCompaniesResponse (0.14.0)

public final class ListCompaniesResponse extends GeneratedMessageV3 implements ListCompaniesResponseOrBuilder

Response object for ListCompaniesRequest containing matching Company objects.

Protobuf type google.ads.admanager.v1.ListCompaniesResponse

Static Fields

COMPANIES_FIELD_NUMBER

public static final int COMPANIES_FIELD_NUMBER
Field Value
Type Description
int

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_SIZE_FIELD_NUMBER

public static final int TOTAL_SIZE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListCompaniesResponse getDefaultInstance()
Returns
Type Description
ListCompaniesResponse

getDescriptor()

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

newBuilder()

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

newBuilder(ListCompaniesResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCompanies(int index)

public Company getCompanies(int index)

The Company objects from the specified network.

repeated .google.ads.admanager.v1.Company companies = 1;

Parameter
Name Description
index int
Returns
Type Description
Company

getCompaniesCount()

public int getCompaniesCount()

The Company objects from the specified network.

repeated .google.ads.admanager.v1.Company companies = 1;

Returns
Type Description
int

getCompaniesList()

public List<Company> getCompaniesList()

The Company objects from the specified network.

repeated .google.ads.admanager.v1.Company companies = 1;

Returns
Type Description
List<Company>

getCompaniesOrBuilder(int index)

public CompanyOrBuilder getCompaniesOrBuilder(int index)

The Company objects from the specified network.

repeated .google.ads.admanager.v1.Company companies = 1;

Parameter
Name Description
index int
Returns
Type Description
CompanyOrBuilder

getCompaniesOrBuilderList()

public List<? extends CompanyOrBuilder> getCompaniesOrBuilderList()

The Company objects from the specified network.

repeated .google.ads.admanager.v1.Company companies = 1;

Returns
Type Description
List<? extends com.google.ads.admanager.v1.CompanyOrBuilder>

getDefaultInstanceForType()

public ListCompaniesResponse getDefaultInstanceForType()
Returns
Type Description
ListCompaniesResponse

getNextPageToken()

public String getNextPageToken()

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string next_page_token = 2;

Returns
Type Description
String

The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string next_page_token = 2;

Returns
Type Description
ByteString

The bytes for nextPageToken.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTotalSize()

public int getTotalSize()

Total number of Company objects. If a filter was included in the request, this reflects the total number after the filtering is applied.

total_size will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.

For more information, see https://developers.google.com/ad-manager/api/beta/field-masks

int32 total_size = 3;

Returns
Type Description
int

The totalSize.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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