public static final class ListAdBreaksRequest.Builder extends GeneratedMessageV3.Builder<ListAdBreaksRequest.Builder> implements ListAdBreaksRequestOrBuilder
Request object for ListAdBreaks
method.
Protobuf type google.ads.admanager.v1.ListAdBreaksRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListAdBreaksRequest.BuilderImplements
ListAdBreaksRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListAdBreaksRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
build()
public ListAdBreaksRequest build()
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest |
buildPartial()
public ListAdBreaksRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest |
clear()
public ListAdBreaksRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListAdBreaksRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
clearFilter()
public ListAdBreaksRequest.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 |
ListAdBreaksRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListAdBreaksRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
clearOrderBy()
public ListAdBreaksRequest.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 |
ListAdBreaksRequest.Builder |
This builder for chaining. |
clearPageSize()
public ListAdBreaksRequest.Builder clearPageSize()
Optional. The maximum number of AdBreaks
to return. The service might
return fewer than this value. If unspecified, at most 10 ad breaks are
returned. The maximum value is 100
. Values above 100
are coerced to
100
.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListAdBreaksRequest.Builder clearPageToken()
Optional. A page token, received from a previous ListAdBreaks
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAdBreaks
must match
the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
This builder for chaining. |
clearParent()
public ListAdBreaksRequest.Builder clearParent()
Required. The parent, which owns this collection of AdBreaks.
Formats:
networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}
networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
This builder for chaining. |
clearSkip()
public ListAdBreaksRequest.Builder clearSkip()
Optional. Number of individual resources to skip while paginating.
int32 skip = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
This builder for chaining. |
clone()
public ListAdBreaksRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
getDefaultInstanceForType()
public ListAdBreaksRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
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 AdBreaks
to return. The service might
return fewer than this value. If unspecified, at most 10 ad breaks are
returned. The maximum value is 100
. Values above 100
are coerced to
100
.
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 ListAdBreaks
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAdBreaks
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 ListAdBreaks
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAdBreaks
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 AdBreaks.
Formats:
networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}
networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}
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 AdBreaks.
Formats:
networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}
networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ListAdBreaksRequest other)
public ListAdBreaksRequest.Builder mergeFrom(ListAdBreaksRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListAdBreaksRequest |
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListAdBreaksRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListAdBreaksRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListAdBreaksRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListAdBreaksRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
setFilter(String value)
public ListAdBreaksRequest.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 |
ListAdBreaksRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListAdBreaksRequest.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 |
ListAdBreaksRequest.Builder |
This builder for chaining. |
setOrderBy(String value)
public ListAdBreaksRequest.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 |
ListAdBreaksRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public ListAdBreaksRequest.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 |
ListAdBreaksRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListAdBreaksRequest.Builder setPageSize(int value)
Optional. The maximum number of AdBreaks
to return. The service might
return fewer than this value. If unspecified, at most 10 ad breaks are
returned. The maximum value is 100
. Values above 100
are coerced to
100
.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
int The pageSize to set. |
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListAdBreaksRequest.Builder setPageToken(String value)
Optional. A page token, received from a previous ListAdBreaks
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAdBreaks
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 |
ListAdBreaksRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListAdBreaksRequest.Builder setPageTokenBytes(ByteString value)
Optional. A page token, received from a previous ListAdBreaks
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAdBreaks
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 |
ListAdBreaksRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListAdBreaksRequest.Builder setParent(String value)
Required. The parent, which owns this collection of AdBreaks.
Formats:
networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}
networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The parent to set. |
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListAdBreaksRequest.Builder setParentBytes(ByteString value)
Required. The parent, which owns this collection of AdBreaks.
Formats:
networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}
networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}
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 |
ListAdBreaksRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListAdBreaksRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |
setSkip(int value)
public ListAdBreaksRequest.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 |
ListAdBreaksRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListAdBreaksRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListAdBreaksRequest.Builder |