com.google.api.services.youtube

Class YouTube.Captions.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<Caption>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.Captions

public class YouTube.Captions.Insert
extends YouTubeRequest<Caption>

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

Method Summary

Modifier and Type	Method and Description
String	getOnBehalfOf() ID of the Google+ Page for the channel that the request is be on behalf of
String	getOnBehalfOfContentOwner() Note:* This parameter is intended exclusively for YouTube content partners.
List<String>	getPart() The *part* parameter specifies the caption resource parts that the API response will include.
Boolean	getSync() Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
YouTube.Captions.Insert	set(String parameterName, Object value)
YouTube.Captions.Insert	set$Xgafv(String $Xgafv) V1 error format.
YouTube.Captions.Insert	setAccessToken(String accessToken) OAuth access token.
YouTube.Captions.Insert	setAlt(String alt) Data format for response.
YouTube.Captions.Insert	setCallback(String callback) JSONP
YouTube.Captions.Insert	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Captions.Insert	setKey(String key) API key.
YouTube.Captions.Insert	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.Captions.Insert	setOnBehalfOf(String onBehalfOf) ID of the Google+ Page for the channel that the request is be on behalf of
YouTube.Captions.Insert	setOnBehalfOfContentOwner(String onBehalfOfContentOwner) *Note:* This parameter is intended exclusively for YouTube content partners.
YouTube.Captions.Insert	setPart(List<String> part) The *part* parameter specifies the caption resource parts that the API response will include.
YouTube.Captions.Insert	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Captions.Insert	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
YouTube.Captions.Insert	setSync(Boolean sync) Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
YouTube.Captions.Insert	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
YouTube.Captions.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,
                 Caption content)

Inserts a new resource into this collection. Create a request for the method "captions.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 specifies the caption resource parts that the API response will include. Set the parameter value to snippet.

content - the Caption

Since:

1.13

Insert

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

Inserts a new resource into this collection. Create a request for the method "captions.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 specifies the caption resource parts that the API response will include. Set the parameter value to snippet.

content - the Caption media metadata or null if none

mediaContent - The media HTTP content or null if none.

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: YouTubeRequest

V1 error format.

Overrides:

set$Xgafv in class YouTubeRequest<Caption>

setAccessToken

public YouTube.Captions.Insert setAccessToken(String accessToken)

Description copied from class: YouTubeRequest

OAuth access token.

Overrides:

setAccessToken in class YouTubeRequest<Caption>

setAlt

public YouTube.Captions.Insert setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for response.

Overrides:

setAlt in class YouTubeRequest<Caption>

setCallback

public YouTube.Captions.Insert setCallback(String callback)

Description copied from class: YouTubeRequest

JSONP

Overrides:

setCallback in class YouTubeRequest<Caption>

setFields

public YouTube.Captions.Insert setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<Caption>

setKey

public YouTube.Captions.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<Caption>

setOauthToken

public YouTube.Captions.Insert setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<Caption>

setPrettyPrint

public YouTube.Captions.Insert setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<Caption>

setQuotaUser

public YouTube.Captions.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<Caption>

setUploadType

public YouTube.Captions.Insert setUploadType(String uploadType)

Description copied from class: YouTubeRequest

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

Overrides:

setUploadType in class YouTubeRequest<Caption>

setUploadProtocol

public YouTube.Captions.Insert setUploadProtocol(String uploadProtocol)

Description copied from class: YouTubeRequest

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

Overrides:

setUploadProtocol in class YouTubeRequest<Caption>

getPart

public List<String> getPart()

The *part* parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.

setPart

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

The *part* parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.

getOnBehalfOf

public String getOnBehalfOf()

ID of the Google+ Page for the channel that the request is be on behalf of

setOnBehalfOf

public YouTube.Captions.Insert setOnBehalfOf(String onBehalfOf)

ID of the Google+ Page for the channel that the request is be on behalf of

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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

setOnBehalfOfContentOwner

public YouTube.Captions.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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

getSync

public Boolean getSync()

Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.

setSync

public YouTube.Captions.Insert setSync(Boolean sync)

Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.

set

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

Overrides:

set in class YouTubeRequest<Caption>