target.apidocs.com.google.api.services.youtube.YouTube.LiveBroadcasts.Bind.html Maven / Gradle / Ivy

Go to download







YouTube.LiveBroadcasts.Bind (YouTube Data API v3-rev20200213-1.30.9)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.youtube
Class YouTube.LiveBroadcasts.Bind



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


com.google.api.services.youtube.YouTube.LiveBroadcasts.Bind

















All Implemented Interfaces:
Cloneable, Map<String,Object>


Enclosing class:
YouTube.LiveBroadcasts




public class YouTube.LiveBroadcasts.Bind
extends YouTubeRequest<LiveBroadcast>











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 
Bind(String id,
    String part)
Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a
 stream.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


String
getId()
The id parameter specifies the unique ID of the broadcast that is being bound to a video stream.



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.



String
getPart()
The part parameter specifies a comma-separated list of one or more liveBroadcast resource
     properties that the API response will include.



String
getStreamId()
The streamId parameter specifies the unique ID of the video stream that is being bound to a
     broadcast.



YouTube.LiveBroadcasts.Bind
set(String parameterName,
   Object value) 


YouTube.LiveBroadcasts.Bind
setAlt(String alt)
Data format for the response.



YouTube.LiveBroadcasts.Bind
setFields(String fields)
Selector specifying which fields to include in a partial response.



YouTube.LiveBroadcasts.Bind
setId(String id)
The id parameter specifies the unique ID of the broadcast that is being bound to a video
 stream.



YouTube.LiveBroadcasts.Bind
setKey(String key)
API key.



YouTube.LiveBroadcasts.Bind
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.



YouTube.LiveBroadcasts.Bind
setOnBehalfOfContentOwner(String onBehalfOfContentOwner)
Note: This parameter is intended exclusively for YouTube content partners.



YouTube.LiveBroadcasts.Bind
setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel)
This parameter can only be used in a properly authorized request.



YouTube.LiveBroadcasts.Bind
setPart(String part)
The part parameter specifies a comma-separated list of one or more liveBroadcast resource
 properties that the API response will include.



YouTube.LiveBroadcasts.Bind
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



YouTube.LiveBroadcasts.Bind
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.



YouTube.LiveBroadcasts.Bind
setStreamId(String streamId)
The streamId parameter specifies the unique ID of the video stream that is being bound to a
 broadcast.



YouTube.LiveBroadcasts.Bind
setUserIp(String userIp)
Deprecated.







Methods inherited from class com.google.api.services.youtube.YouTubeRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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





Bind
protected Bind(String id,
               String part)
Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a
 stream. A broadcast can only be bound to one video stream, though a video stream may be bound
 to more than one broadcast.

 Create a request for the method "liveBroadcasts.bind".

 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:
id - The id parameter specifies the unique ID of the broadcast that is being bound to a video stream.
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.
Since:
1.13










Method Detail





setAlt
public YouTube.LiveBroadcasts.Bind setAlt(String alt)
Description copied from class: YouTubeRequest
Data format for the response.

Overrides:
setAlt in class YouTubeRequest<LiveBroadcast>








setFields
public YouTube.LiveBroadcasts.Bind setFields(String fields)
Description copied from class: YouTubeRequest
Selector specifying which fields to include in a partial response.

Overrides:
setFields in class YouTubeRequest<LiveBroadcast>








setKey
public YouTube.LiveBroadcasts.Bind 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<LiveBroadcast>








setOauthToken
public YouTube.LiveBroadcasts.Bind setOauthToken(String oauthToken)
Description copied from class: YouTubeRequest
OAuth 2.0 token for the current user.

Overrides:
setOauthToken in class YouTubeRequest<LiveBroadcast>








setPrettyPrint
public YouTube.LiveBroadcasts.Bind setPrettyPrint(Boolean prettyPrint)
Description copied from class: YouTubeRequest
Returns response with indentations and line breaks.

Overrides:
setPrettyPrint in class YouTubeRequest<LiveBroadcast>








setQuotaUser
public YouTube.LiveBroadcasts.Bind setQuotaUser(String quotaUser)
Description copied from class: YouTubeRequest
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:
setQuotaUser in class YouTubeRequest<LiveBroadcast>








setUserIp
public YouTube.LiveBroadcasts.Bind setUserIp(String userIp)
Description copied from class: YouTubeRequest
Deprecated. Please use quotaUser instead.

Overrides:
setUserIp in class YouTubeRequest<LiveBroadcast>








getId
public String getId()
The id parameter specifies the unique ID of the broadcast that is being bound to a video stream.







setId
public YouTube.LiveBroadcasts.Bind setId(String id)
The id parameter specifies the unique ID of the broadcast that is being bound to a video
 stream.







getPart
public 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.LiveBroadcasts.Bind setPart(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.







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.LiveBroadcasts.Bind 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.LiveBroadcasts.Bind 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.







getStreamId
public String getStreamId()
The streamId parameter specifies the unique ID of the video stream that is being bound to a
     broadcast. If this parameter is omitted, the API will remove any existing binding between the
     broadcast and a video stream.







setStreamId
public YouTube.LiveBroadcasts.Bind setStreamId(String streamId)
The streamId parameter specifies the unique ID of the video stream that is being bound to a
 broadcast. If this parameter is omitted, the API will remove any existing binding between
 the broadcast and a video stream.







set
public YouTube.LiveBroadcasts.Bind set(String parameterName,
                                       Object value)

Overrides:
set in class YouTubeRequest<LiveBroadcast>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.

Modifier and Type	Method and Description
`String`	`getId()` The id parameter specifies the unique ID of the broadcast that is being bound to a video stream.
`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.
`String`	`getPart()` The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include.
`String`	`getStreamId()` The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast.
`YouTube.LiveBroadcasts.Bind`	`set(String parameterName, Object value)`
`YouTube.LiveBroadcasts.Bind`	`setAlt(String alt)` Data format for the response.
`YouTube.LiveBroadcasts.Bind`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`YouTube.LiveBroadcasts.Bind`	`setId(String id)` The id parameter specifies the unique ID of the broadcast that is being bound to a video stream.
`YouTube.LiveBroadcasts.Bind`	`setKey(String key)` API key.
`YouTube.LiveBroadcasts.Bind`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`YouTube.LiveBroadcasts.Bind`	`setOnBehalfOfContentOwner(String onBehalfOfContentOwner)` Note: This parameter is intended exclusively for YouTube content partners.
`YouTube.LiveBroadcasts.Bind`	`setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel)` This parameter can only be used in a properly authorized request.
`YouTube.LiveBroadcasts.Bind`	`setPart(String part)` The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include.
`YouTube.LiveBroadcasts.Bind`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`YouTube.LiveBroadcasts.Bind`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`YouTube.LiveBroadcasts.Bind`	`setStreamId(String streamId)` The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast.
`YouTube.LiveBroadcasts.Bind`	`setUserIp(String userIp)` Deprecated.