Class ListChangeEventsRequest.Builder (0.62.0)

public static final class ListChangeEventsRequest.Builder extends GeneratedMessage.Builder<ListChangeEventsRequest.Builder> implements ListChangeEventsRequestOrBuilder

Request object for ListChangeEvents method.

Protobuf type google.ads.admanager.v1.ListChangeEventsRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListChangeEventsRequest build()
Returns
Type Description
ListChangeEventsRequest

buildPartial()

public ListChangeEventsRequest buildPartial()
Returns
Type Description
ListChangeEventsRequest

clear()

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

clearFilter()

public ListChangeEventsRequest.Builder clearFilter()

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

Syntax summary: double-quoted "..." (never '...') strings and RFC 3339 timestamps, full resource names on reference fields (for example, order = "networks/123/orders/456", not Id or bare IDs), prefix or suffix wildcards with = (displayName = "foo*"), : for substring or repeated-field matching, unquoted enums and booleans, uppercase AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN (...)).

Filterable fields:

  • changeTime
  • entityId
  • name
  • operationType
  • resourceType
  • user

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

Returns
Type Description
ListChangeEventsRequest.Builder

This builder for chaining.

clearPageSize()

public ListChangeEventsRequest.Builder clearPageSize()

Optional. The maximum number of ChangeEvent objects to return. The service may return fewer than this value. If unspecified, at most 50 ChangeEvent objects 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
ListChangeEventsRequest.Builder

This builder for chaining.

clearPageToken()

public ListChangeEventsRequest.Builder clearPageToken()

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

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

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

Returns
Type Description
ListChangeEventsRequest.Builder

This builder for chaining.

clearParent()

public ListChangeEventsRequest.Builder clearParent()

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

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

Returns
Type Description
ListChangeEventsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListChangeEventsRequest getDefaultInstanceForType()
Returns
Type Description
ListChangeEventsRequest

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

Syntax summary: double-quoted "..." (never '...') strings and RFC 3339 timestamps, full resource names on reference fields (for example, order = "networks/123/orders/456", not Id or bare IDs), prefix or suffix wildcards with = (displayName = "foo*"), : for substring or repeated-field matching, unquoted enums and booleans, uppercase AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN (...)).

Filterable fields:

  • changeTime
  • entityId
  • name
  • operationType
  • resourceType
  • user

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

Syntax summary: double-quoted "..." (never '...') strings and RFC 3339 timestamps, full resource names on reference fields (for example, order = "networks/123/orders/456", not Id or bare IDs), prefix or suffix wildcards with = (displayName = "foo*"), : for substring or repeated-field matching, unquoted enums and booleans, uppercase AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN (...)).

Filterable fields:

  • changeTime
  • entityId
  • name
  • operationType
  • resourceType
  • user

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The maximum number of ChangeEvent objects to return. The service may return fewer than this value. If unspecified, at most 50 ChangeEvent objects 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 ListChangeEvents call. Provide this to retrieve the subsequent page.

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

When paginating, all other parameters provided to ListChangeEvents 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 ChangeEvents. 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 ChangeEvents. 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(ListChangeEventsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public ListChangeEventsRequest.Builder setFilter(String value)

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

Syntax summary: double-quoted "..." (never '...') strings and RFC 3339 timestamps, full resource names on reference fields (for example, order = "networks/123/orders/456", not Id or bare IDs), prefix or suffix wildcards with = (displayName = "foo*"), : for substring or repeated-field matching, unquoted enums and booleans, uppercase AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN (...)).

Filterable fields:

  • changeTime
  • entityId
  • name
  • operationType
  • resourceType
  • user

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListChangeEventsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListChangeEventsRequest.Builder setFilterBytes(ByteString value)

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

Syntax summary: double-quoted "..." (never '...') strings and RFC 3339 timestamps, full resource names on reference fields (for example, order = "networks/123/orders/456", not Id or bare IDs), prefix or suffix wildcards with = (displayName = "foo*"), : for substring or repeated-field matching, unquoted enums and booleans, uppercase AND/OR/NOT, and standalone IN(field, SET(v1, v2)) (not field IN (...)).

Filterable fields:

  • changeTime
  • entityId
  • name
  • operationType
  • resourceType
  • user

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListChangeEventsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListChangeEventsRequest.Builder setPageSize(int value)

Optional. The maximum number of ChangeEvent objects to return. The service may return fewer than this value. If unspecified, at most 50 ChangeEvent objects 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
ListChangeEventsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListChangeEventsRequest.Builder setPageToken(String value)

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

When paginating, all other parameters provided to ListChangeEvents 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
ListChangeEventsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListChangeEventsRequest.Builder setPageTokenBytes(ByteString value)

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

When paginating, all other parameters provided to ListChangeEvents 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
ListChangeEventsRequest.Builder

This builder for chaining.

setParent(String value)

public ListChangeEventsRequest.Builder setParent(String value)

Required. The parent, which owns this collection of ChangeEvents. 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
ListChangeEventsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListChangeEventsRequest.Builder setParentBytes(ByteString value)

Required. The parent, which owns this collection of ChangeEvents. 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
ListChangeEventsRequest.Builder

This builder for chaining.