Class ListOrganizationsRequest.Builder (0.29.0)

public static final class ListOrganizationsRequest.Builder extends GeneratedMessageV3.Builder<ListOrganizationsRequest.Builder> implements ListOrganizationsRequestOrBuilder

Request message for ListOrganizations RPC.

Protobuf type google.marketingplatform.admin.v1alpha.ListOrganizationsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListOrganizationsRequest build()
Returns
Type Description
ListOrganizationsRequest

buildPartial()

public ListOrganizationsRequest buildPartial()
Returns
Type Description
ListOrganizationsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListOrganizationsRequest.Builder clearPageSize()

Optional. The maximum number of organizations to return in one call. The service may return fewer than this value.

If unspecified, at most 50 organizations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
Type Description
ListOrganizationsRequest.Builder

This builder for chaining.

clearPageToken()

public ListOrganizationsRequest.Builder clearPageToken()

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

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

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

Returns
Type Description
ListOrganizationsRequest.Builder

This builder for chaining.

clone()

public ListOrganizationsRequest.Builder clone()
Returns
Type Description
ListOrganizationsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListOrganizationsRequest getDefaultInstanceForType()
Returns
Type Description
ListOrganizationsRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

Optional. The maximum number of organizations to return in one call. The service may return fewer than this value.

If unspecified, at most 50 organizations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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

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

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

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

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

Returns
Type Description
ByteString

The bytes for pageToken.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListOrganizationsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public ListOrganizationsRequest.Builder setPageSize(int value)

Optional. The maximum number of organizations to return in one call. The service may return fewer than this value.

If unspecified, at most 50 organizations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListOrganizationsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListOrganizationsRequest.Builder setPageToken(String value)

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

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

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListOrganizationsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListOrganizationsRequest.Builder setPageTokenBytes(ByteString value)

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

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

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListOrganizationsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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