com.google.api.services.youtube

Class YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.youtube.YouTubeRequest<Cuepoint>

com.google.api.services.youtube.YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.Youtube.V3.LiveBroadcasts.Cuepoint

public class YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create
extends YouTubeRequest<Cuepoint>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Create() Insert cuepoints in a broadcast Create a request for the method "cuepoint.create".

Method Summary

Modifier and Type	Method and Description
String	getId() Broadcast to insert ads to, or equivalently `external_video_id` for internal use.
String	getOnBehalfOfContentOwner() Note:* This parameter is intended exclusively for YouTube content partners.
String	getOnBehalfOfContentOwnerChannel() This parameter can only be used in a properly authorized request.
List<String>	getPart() The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include.
String	getResourceCueType()
Long	getResourceDurationSecs() The duration of this cuepoint.
String	getResourceId() The identifier for cuepoint resource.
Long	getResourceInsertionOffsetTimeMs() The time when the cuepoint should be inserted by offset to the broadcast actual start time.
BigInteger	getResourceWalltimeMs() The wall clock time at which the cuepoint should be inserted.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	set(String parameterName, Object value)
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	set$Xgafv(String $Xgafv) V1 error format.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setAccessToken(String accessToken) OAuth access token.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setAlt(String alt) Data format for response.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setCallback(String callback) JSONP
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setId(String id) Broadcast to insert ads to, or equivalently `external_video_id` for internal use.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setKey(String key) API key.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setOnBehalfOfContentOwner(String onBehalfOfContentOwner) *Note:* This parameter is intended exclusively for YouTube content partners.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel) This parameter can only be used in a properly authorized request.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setPart(List<String> part) The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setResourceCueType(String resourceCueType)
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setResourceDurationSecs(Long resourceDurationSecs) The duration of this cuepoint.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setResourceId(String resourceId) The identifier for cuepoint resource.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setResourceInsertionOffsetTimeMs(Long resourceInsertionOffsetTimeMs) The time when the cuepoint should be inserted by offset to the broadcast actual start time.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setResourceWalltimeMs(BigInteger resourceWalltimeMs) The wall clock time at which the cuepoint should be inserted.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.youtube.YouTubeRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Create

protected Create()

Insert cuepoints in a broadcast Create a request for the method "cuepoint.create". This request holds the parameters needed by the the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

YouTube.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Since:

1.13

Method Detail

set$Xgafv

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create set$Xgafv(String $Xgafv)

Description copied from class: YouTubeRequest

V1 error format.

Overrides:

set$Xgafv in class YouTubeRequest<Cuepoint>

setAccessToken

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setAccessToken(String accessToken)

Description copied from class: YouTubeRequest

OAuth access token.

Overrides:

setAccessToken in class YouTubeRequest<Cuepoint>

setAlt

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for response.

Overrides:

setAlt in class YouTubeRequest<Cuepoint>

setCallback

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setCallback(String callback)

Description copied from class: YouTubeRequest

JSONP

Overrides:

setCallback in class YouTubeRequest<Cuepoint>

setFields

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<Cuepoint>

setKey

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setKey(String key)

Description copied from class: YouTubeRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class YouTubeRequest<Cuepoint>

setOauthToken

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<Cuepoint>

setPrettyPrint

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<Cuepoint>

setQuotaUser

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setQuotaUser(String quotaUser)

Description copied from class: YouTubeRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class YouTubeRequest<Cuepoint>

setUploadType

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setUploadType(String uploadType)

Description copied from class: YouTubeRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class YouTubeRequest<Cuepoint>

setUploadProtocol

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setUploadProtocol(String uploadProtocol)

Description copied from class: YouTubeRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class YouTubeRequest<Cuepoint>

getId

public String getId()

Broadcast to insert ads to, or equivalently `external_video_id` for internal use.

setId

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setId(String id)

Broadcast to insert ads to, or equivalently `external_video_id` for internal use.

getOnBehalfOfContentOwner

public String getOnBehalfOfContentOwner()

Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

setOnBehalfOfContentOwner

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setOnBehalfOfContentOwner(String onBehalfOfContentOwner)

*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

getOnBehalfOfContentOwnerChannel

public String getOnBehalfOfContentOwnerChannel()

This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

setOnBehalfOfContentOwnerChannel

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel)

This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

getPart

public List<String> getPart()

The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.

setPart

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setPart(List<String> part)

The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.

getResourceCueType

public String getResourceCueType()

setResourceCueType

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setResourceCueType(String resourceCueType)

getResourceDurationSecs

public Long getResourceDurationSecs()

The duration of this cuepoint.

setResourceDurationSecs

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setResourceDurationSecs(Long resourceDurationSecs)

The duration of this cuepoint.

getResourceId

public String getResourceId()

The identifier for cuepoint resource.

setResourceId

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setResourceId(String resourceId)

The identifier for cuepoint resource.

getResourceInsertionOffsetTimeMs

public Long getResourceInsertionOffsetTimeMs()

The time when the cuepoint should be inserted by offset to the broadcast actual start time.

setResourceInsertionOffsetTimeMs

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setResourceInsertionOffsetTimeMs(Long resourceInsertionOffsetTimeMs)

The time when the cuepoint should be inserted by offset to the broadcast actual start time.

getResourceWalltimeMs

public BigInteger getResourceWalltimeMs()

The wall clock time at which the cuepoint should be inserted. Only one of insertion_offset_time_ms and walltime_ms may be set at a time.

setResourceWalltimeMs

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create setResourceWalltimeMs(BigInteger resourceWalltimeMs)

The wall clock time at which the cuepoint should be inserted. Only one of insertion_offset_time_ms and walltime_ms may be set at a time.

set

public YouTube.Youtube.V3.LiveBroadcasts.Cuepoint.Create set(String parameterName,
                                                             Object value)

Overrides:

set in class YouTubeRequest<Cuepoint>