Class FetchMcmEarningsRequest.Builder (0.52.0)

public static final class FetchMcmEarningsRequest.Builder extends GeneratedMessage.Builder<FetchMcmEarningsRequest.Builder> implements FetchMcmEarningsRequestOrBuilder

Request object for FetchMcmEarnings method.

Protobuf type google.ads.admanager.v1.FetchMcmEarningsRequest

Static Methods

getDescriptor()

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

Methods

build()

public FetchMcmEarningsRequest build()
Returns
Type Description
FetchMcmEarningsRequest

buildPartial()

public FetchMcmEarningsRequest buildPartial()
Returns
Type Description
FetchMcmEarningsRequest

clear()

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

clearFilter()

public FetchMcmEarningsRequest.Builder clearFilter()

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

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

Returns
Type Description
FetchMcmEarningsRequest.Builder

This builder for chaining.

clearMonth()

public FetchMcmEarningsRequest.Builder clearMonth()

Required. The month to fetch earnings for. The date will be specified as the first of the month.

.google.type.Date month = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FetchMcmEarningsRequest.Builder

clearOrderBy()

public FetchMcmEarningsRequest.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
FetchMcmEarningsRequest.Builder

This builder for chaining.

clearPageSize()

public FetchMcmEarningsRequest.Builder clearPageSize()

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

This builder for chaining.

clearPageToken()

public FetchMcmEarningsRequest.Builder clearPageToken()

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

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

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

Returns
Type Description
FetchMcmEarningsRequest.Builder

This builder for chaining.

clearParent()

public FetchMcmEarningsRequest.Builder clearParent()

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

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

Returns
Type Description
FetchMcmEarningsRequest.Builder

This builder for chaining.

clearSkip()

public FetchMcmEarningsRequest.Builder clearSkip()

Optional. Number of individual resources to skip while paginating.

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

Returns
Type Description
FetchMcmEarningsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public FetchMcmEarningsRequest getDefaultInstanceForType()
Returns
Type Description
FetchMcmEarningsRequest

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

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

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

Returns
Type Description
ByteString

The bytes for filter.

getMonth()

public Date getMonth()

Required. The month to fetch earnings for. The date will be specified as the first of the month.

.google.type.Date month = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.Date

The month.

getMonthBuilder()

public Date.Builder getMonthBuilder()

Required. The month to fetch earnings for. The date will be specified as the first of the month.

.google.type.Date month = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.Date.Builder

getMonthOrBuilder()

public DateOrBuilder getMonthOrBuilder()

Required. The month to fetch earnings for. The date will be specified as the first of the month.

.google.type.Date month = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.DateOrBuilder

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 McmEarnings to return. The service may return fewer than this value. If unspecified, at most 50 McmEarnings 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 FetchMcmEarnings call. Provide this to retrieve the subsequent page.

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

When paginating, all other parameters provided to FetchMcmEarnings 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 McmEarnings. 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 McmEarnings. 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.

hasMonth()

public boolean hasMonth()

Required. The month to fetch earnings for. The date will be specified as the first of the month.

.google.type.Date month = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the month field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FetchMcmEarningsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeMonth(Date value)

public FetchMcmEarningsRequest.Builder mergeMonth(Date value)

Required. The month to fetch earnings for. The date will be specified as the first of the month.

.google.type.Date month = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
FetchMcmEarningsRequest.Builder

setFilter(String value)

public FetchMcmEarningsRequest.Builder setFilter(String value)

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

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
FetchMcmEarningsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public FetchMcmEarningsRequest.Builder setFilterBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
FetchMcmEarningsRequest.Builder

This builder for chaining.

setMonth(Date value)

public FetchMcmEarningsRequest.Builder setMonth(Date value)

Required. The month to fetch earnings for. The date will be specified as the first of the month.

.google.type.Date month = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
FetchMcmEarningsRequest.Builder

setMonth(Date.Builder builderForValue)

public FetchMcmEarningsRequest.Builder setMonth(Date.Builder builderForValue)

Required. The month to fetch earnings for. The date will be specified as the first of the month.

.google.type.Date month = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue com.google.type.Date.Builder
Returns
Type Description
FetchMcmEarningsRequest.Builder

setOrderBy(String value)

public FetchMcmEarningsRequest.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
FetchMcmEarningsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public FetchMcmEarningsRequest.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
FetchMcmEarningsRequest.Builder

This builder for chaining.

setPageSize(int value)

public FetchMcmEarningsRequest.Builder setPageSize(int value)

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

This builder for chaining.

setPageToken(String value)

public FetchMcmEarningsRequest.Builder setPageToken(String value)

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

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

This builder for chaining.

setPageTokenBytes(ByteString value)

public FetchMcmEarningsRequest.Builder setPageTokenBytes(ByteString value)

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

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

This builder for chaining.

setParent(String value)

public FetchMcmEarningsRequest.Builder setParent(String value)

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

This builder for chaining.

setParentBytes(ByteString value)

public FetchMcmEarningsRequest.Builder setParentBytes(ByteString value)

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

This builder for chaining.

setSkip(int value)

public FetchMcmEarningsRequest.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
FetchMcmEarningsRequest.Builder

This builder for chaining.