Class ListCustomFieldsRequest (0.5.0)

public final class ListCustomFieldsRequest extends GeneratedMessageV3 implements ListCustomFieldsRequestOrBuilder

Request object for ListCustomFields method.

Protobuf type google.ads.admanager.v1.ListCustomFieldsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SKIP_FIELD_NUMBER

public static final int SKIP_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListCustomFieldsRequest getDefaultInstance()
Returns
Type Description
ListCustomFieldsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ListCustomFieldsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ListCustomFieldsRequest getDefaultInstanceForType()
Returns
Type Description
ListCustomFieldsRequest

getFilter()

public String getFilter()

Optional. Expression to filter the response. See syntax details at https://google.aip.dev/160

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://google.aip.dev/160

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://google.aip.dev/132#ordering

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://google.aip.dev/132#ordering

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 CustomFields to return. The service may return fewer than this value. If unspecified, at most 50 CustomFields will be returned. The maximum value is 1000; values above 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 ListCustomFields call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCustomFields 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 ListCustomFields call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCustomFields 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 CustomFields. 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 CustomFields. Format: networks/{network_code}

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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