com.google.api.services.youtube

Class YouTube.Videos.Insert

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<Video>

com.google.api.services.youtube.YouTube.Videos.Insert

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.Videos

public class YouTube.Videos.Insert
extends YouTubeRequest<Video>

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	Insert(List<String> part, Video content) Inserts a new resource into this collection.
protected	Insert(List<String> part, Video content, AbstractInputStreamContent mediaContent) Inserts a new resource into this collection.

Method Summary

Modifier and Type	Method and Description
Boolean	getAutoLevels() Should auto-levels be applied to the upload.
Boolean	getNotifySubscribers() Notify the channel subscribers about the new video.
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 serves two purposes in this operation.
Boolean	getStabilize() Should stabilize be applied to the upload.
boolean	isNotifySubscribers() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
YouTube.Videos.Insert	set(String parameterName, Object value)
YouTube.Videos.Insert	set$Xgafv(String $Xgafv) V1 error format.
YouTube.Videos.Insert	setAccessToken(String accessToken) OAuth access token.
YouTube.Videos.Insert	setAlt(String alt) Data format for response.
YouTube.Videos.Insert	setAutoLevels(Boolean autoLevels) Should auto-levels be applied to the upload.
YouTube.Videos.Insert	setCallback(String callback) JSONP
YouTube.Videos.Insert	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Videos.Insert	setKey(String key) API key.
YouTube.Videos.Insert	setNotifySubscribers(Boolean notifySubscribers) Notify the channel subscribers about the new video.
YouTube.Videos.Insert	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.Videos.Insert	setOnBehalfOfContentOwner(String onBehalfOfContentOwner) *Note:* This parameter is intended exclusively for YouTube content partners.
YouTube.Videos.Insert	setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel) This parameter can only be used in a properly authorized request.
YouTube.Videos.Insert	setPart(List<String> part) The *part* parameter serves two purposes in this operation.
YouTube.Videos.Insert	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Videos.Insert	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
YouTube.Videos.Insert	setStabilize(Boolean stabilize) Should stabilize be applied to the upload.
YouTube.Videos.Insert	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
YouTube.Videos.Insert	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

Insert

protected Insert(List<String> part,
                 Video content)

Inserts a new resource into this collection. Create a request for the method "videos.insert". 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.

Parameters:

part - The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.

content - the Video

Since:

1.13

Insert

protected Insert(List<String> part,
                 Video content,
                 AbstractInputStreamContent mediaContent)

Inserts a new resource into this collection. Create a request for the method "videos.insert". 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.

This constructor should be used for uploading media content.

Parameters:

part - The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.

content - the Video media metadata or null if none

mediaContent - The media HTTP content or null if none.

Since:

1.13

Method Detail

set$Xgafv

public YouTube.Videos.Insert set$Xgafv(String $Xgafv)

Description copied from class: YouTubeRequest

V1 error format.

Overrides:

set$Xgafv in class YouTubeRequest<Video>

setAccessToken

public YouTube.Videos.Insert setAccessToken(String accessToken)

Description copied from class: YouTubeRequest

OAuth access token.

Overrides:

setAccessToken in class YouTubeRequest<Video>

setAlt

public YouTube.Videos.Insert setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for response.

Overrides:

setAlt in class YouTubeRequest<Video>

setCallback

public YouTube.Videos.Insert setCallback(String callback)

Description copied from class: YouTubeRequest

JSONP

Overrides:

setCallback in class YouTubeRequest<Video>

setFields

public YouTube.Videos.Insert setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<Video>

setKey

public YouTube.Videos.Insert 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<Video>

setOauthToken

public YouTube.Videos.Insert setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<Video>

setPrettyPrint

public YouTube.Videos.Insert setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<Video>

setQuotaUser

public YouTube.Videos.Insert 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<Video>

setUploadType

public YouTube.Videos.Insert setUploadType(String uploadType)

Description copied from class: YouTubeRequest

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

Overrides:

setUploadType in class YouTubeRequest<Video>

setUploadProtocol

public YouTube.Videos.Insert setUploadProtocol(String uploadProtocol)

Description copied from class: YouTubeRequest

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

Overrides:

setUploadProtocol in class YouTubeRequest<Video>

getPart

public List<String> getPart()

The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.

setPart

public YouTube.Videos.Insert setPart(List<String> part)

The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.

getAutoLevels

public Boolean getAutoLevels()

Should auto-levels be applied to the upload.

setAutoLevels

public YouTube.Videos.Insert setAutoLevels(Boolean autoLevels)

Should auto-levels be applied to the upload.

getNotifySubscribers

public Boolean getNotifySubscribers()

Notify the channel subscribers about the new video. As default, the notification is enabled. [default: true]

setNotifySubscribers

public YouTube.Videos.Insert setNotifySubscribers(Boolean notifySubscribers)

Notify the channel subscribers about the new video. As default, the notification is enabled.

isNotifySubscribers

public boolean isNotifySubscribers()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Notify the channel subscribers about the new video. As default, the notification is enabled.

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.Videos.Insert 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.Videos.Insert 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.

getStabilize

public Boolean getStabilize()

Should stabilize be applied to the upload.

setStabilize

public YouTube.Videos.Insert setStabilize(Boolean stabilize)

Should stabilize be applied to the upload.

set

public YouTube.Videos.Insert set(String parameterName,
                                 Object value)

Overrides:

set in class YouTubeRequest<Video>