Class VideoStitcherServiceClient (0.1.0)

public class VideoStitcherServiceClient implements BackgroundResource

Service Description: Video-On-Demand content stitching API allows you to insert ads into (VoD) video on demand files. You will be able to render custom scrubber bars with highlighted ads, enforce ad policies, allow seamless playback and tracking on native players and monetize content with any standard VMAP compliant ad server.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   CdnKey cdnKey = CdnKey.newBuilder().build();
   String cdnKeyId = "cdnKeyId-1777782867";
   CdnKey response = videoStitcherServiceClient.createCdnKey(parent, cdnKey, cdnKeyId);
 }

Note: close() needs to be called on the VideoStitcherServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of VideoStitcherServiceSettings to create(). For example:

To customize credentials:


 VideoStitcherServiceSettings videoStitcherServiceSettings =
     VideoStitcherServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create(videoStitcherServiceSettings);

To customize the endpoint:


 VideoStitcherServiceSettings videoStitcherServiceSettings =
     VideoStitcherServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create(videoStitcherServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > VideoStitcherServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final VideoStitcherServiceClient create()

Constructs an instance of VideoStitcherServiceClient with default settings.

Returns

Type	Description
VideoStitcherServiceClient

Exceptions

Type	Description
IOException

create(VideoStitcherServiceSettings settings)

public static final VideoStitcherServiceClient create(VideoStitcherServiceSettings settings)

Constructs an instance of VideoStitcherServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter

Name	Description
settings	`VideoStitcherServiceSettings`

Returns

Type	Description
VideoStitcherServiceClient

Exceptions

Type	Description
IOException

create(VideoStitcherServiceStub stub)

public static final VideoStitcherServiceClient create(VideoStitcherServiceStub stub)

Constructs an instance of VideoStitcherServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(VideoStitcherServiceSettings).

Parameter

Name	Description
stub	`VideoStitcherServiceStub`

Returns

Type	Description
VideoStitcherServiceClient

Constructors

VideoStitcherServiceClient(VideoStitcherServiceSettings settings)

protected VideoStitcherServiceClient(VideoStitcherServiceSettings settings)

Constructs an instance of VideoStitcherServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter

Name	Description
settings	`VideoStitcherServiceSettings`

VideoStitcherServiceClient(VideoStitcherServiceStub stub)

protected VideoStitcherServiceClient(VideoStitcherServiceStub stub)

Parameter

Name	Description
stub	`VideoStitcherServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	`long`
unit	`TimeUnit`

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

createCdnKey(CreateCdnKeyRequest request)

public final CdnKey createCdnKey(CreateCdnKeyRequest request)

Creates a new CDN key.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   CreateCdnKeyRequest request =
       CreateCdnKeyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCdnKey(CdnKey.newBuilder().build())
           .setCdnKeyId("cdnKeyId-1777782867")
           .build();
   CdnKey response = videoStitcherServiceClient.createCdnKey(request);
 }

Parameter

Name	Description
request	`CreateCdnKeyRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
CdnKey

createCdnKey(LocationName parent, CdnKey cdnKey, String cdnKeyId)

public final CdnKey createCdnKey(LocationName parent, CdnKey cdnKey, String cdnKeyId)

Creates a new CDN key.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   CdnKey cdnKey = CdnKey.newBuilder().build();
   String cdnKeyId = "cdnKeyId-1777782867";
   CdnKey response = videoStitcherServiceClient.createCdnKey(parent, cdnKey, cdnKeyId);
 }

Parameters

Name	Description
parent	`LocationName` Required. The project in which the CDN key should be created, in the form of `projects/{project_number}/locations/{location}`.
cdnKey	`CdnKey` Required. The CDN key resource to create.
cdnKeyId	`String` Required. The ID to use for the CDN key, which will become the final component of the CDN key's resource name. This value should conform to RFC-1034, which restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.

Returns

Type	Description
CdnKey

createCdnKey(String parent, CdnKey cdnKey, String cdnKeyId)

public final CdnKey createCdnKey(String parent, CdnKey cdnKey, String cdnKeyId)

Creates a new CDN key.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   CdnKey cdnKey = CdnKey.newBuilder().build();
   String cdnKeyId = "cdnKeyId-1777782867";
   CdnKey response = videoStitcherServiceClient.createCdnKey(parent, cdnKey, cdnKeyId);
 }

Parameters

Name	Description
parent	`String` Required. The project in which the CDN key should be created, in the form of `projects/{project_number}/locations/{location}`.
cdnKey	`CdnKey` Required. The CDN key resource to create.
cdnKeyId	`String` Required. The ID to use for the CDN key, which will become the final component of the CDN key's resource name. This value should conform to RFC-1034, which restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.

Returns

Type	Description
CdnKey

createCdnKeyCallable()

public final UnaryCallable<CreateCdnKeyRequest,CdnKey> createCdnKeyCallable()

Creates a new CDN key.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   CreateCdnKeyRequest request =
       CreateCdnKeyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCdnKey(CdnKey.newBuilder().build())
           .setCdnKeyId("cdnKeyId-1777782867")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateCdnKeyRequest,CdnKey>

createLiveSession(CreateLiveSessionRequest request)

public final LiveSession createLiveSession(CreateLiveSessionRequest request)

Creates a new live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   CreateLiveSessionRequest request =
       CreateLiveSessionRequest.newBuilder()
           .setParent(LiveSessionName.of("[PROJECT]", "[LOCATION]", "[LIVE_SESSION]").toString())
           .setLiveSession(LiveSession.newBuilder().build())
           .build();
   LiveSession response = videoStitcherServiceClient.createLiveSession(request);
 }

Parameter

Name	Description
request	`CreateLiveSessionRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LiveSession

createLiveSession(LiveSessionName parent, LiveSession liveSession)

public final LiveSession createLiveSession(LiveSessionName parent, LiveSession liveSession)

Creates a new live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   LiveSessionName parent = LiveSessionName.of("[PROJECT]", "[LOCATION]", "[LIVE_SESSION]");
   LiveSession liveSession = LiveSession.newBuilder().build();
   LiveSession response = videoStitcherServiceClient.createLiveSession(parent, liveSession);
 }

Parameters

Name Description

parent

LiveSessionName

Required. The project and location in which the live session should be created, in the form of projects/{project_number}/locations/{location}.

Valid locations:

- (Video Stitcher API will pick a location that is closest to the caller.)
us-east1
us-west1
us-central1
europe-west1

liveSession

LiveSession

Required. Parameters for creating a live session.

Returns

Type	Description
LiveSession

createLiveSession(String parent, LiveSession liveSession)

public final LiveSession createLiveSession(String parent, LiveSession liveSession)

Creates a new live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String parent = LiveSessionName.of("[PROJECT]", "[LOCATION]", "[LIVE_SESSION]").toString();
   LiveSession liveSession = LiveSession.newBuilder().build();
   LiveSession response = videoStitcherServiceClient.createLiveSession(parent, liveSession);
 }

Parameters

Name Description

parent

String

Required. The project and location in which the live session should be created, in the form of projects/{project_number}/locations/{location}.

Valid locations:

- (Video Stitcher API will pick a location that is closest to the caller.)
us-east1
us-west1
us-central1
europe-west1

liveSession

LiveSession

Required. Parameters for creating a live session.

Returns

Type	Description
LiveSession

createLiveSessionCallable()

public final UnaryCallable<CreateLiveSessionRequest,LiveSession> createLiveSessionCallable()

Creates a new live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   CreateLiveSessionRequest request =
       CreateLiveSessionRequest.newBuilder()
           .setParent(LiveSessionName.of("[PROJECT]", "[LOCATION]", "[LIVE_SESSION]").toString())
           .setLiveSession(LiveSession.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateLiveSessionRequest,LiveSession>

createSlate(CreateSlateRequest request)

public final Slate createSlate(CreateSlateRequest request)

Creates a slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   CreateSlateRequest request =
       CreateSlateRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSlateId("slateId-2126174060")
           .setSlate(Slate.newBuilder().build())
           .build();
   Slate response = videoStitcherServiceClient.createSlate(request);
 }

Parameter

Name	Description
request	`CreateSlateRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
Slate

createSlate(LocationName parent, Slate slate, String slateId)

public final Slate createSlate(LocationName parent, Slate slate, String slateId)

Creates a slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Slate slate = Slate.newBuilder().build();
   String slateId = "slateId-2126174060";
   Slate response = videoStitcherServiceClient.createSlate(parent, slate, slateId);
 }

Parameters

Name	Description
parent	`LocationName` Required. The project in which the slate should be created, in the form of `projects/{project_number}`.
slate	`Slate` Required. The slate to create.
slateId	`String` Required. The unique identifier for the slate. This value should conform to RFC-1034, which restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.

Returns

Type	Description
Slate

createSlate(String parent, Slate slate, String slateId)

public final Slate createSlate(String parent, Slate slate, String slateId)

Creates a slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Slate slate = Slate.newBuilder().build();
   String slateId = "slateId-2126174060";
   Slate response = videoStitcherServiceClient.createSlate(parent, slate, slateId);
 }

Parameters

Name	Description
parent	`String` Required. The project in which the slate should be created, in the form of `projects/{project_number}`.
slate	`Slate` Required. The slate to create.
slateId	`String` Required. The unique identifier for the slate. This value should conform to RFC-1034, which restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.

Returns

Type	Description
Slate

createSlateCallable()

public final UnaryCallable<CreateSlateRequest,Slate> createSlateCallable()

Creates a slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   CreateSlateRequest request =
       CreateSlateRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSlateId("slateId-2126174060")
           .setSlate(Slate.newBuilder().build())
           .build();
   ApiFuture<Slate> future =
       videoStitcherServiceClient.createSlateCallable().futureCall(request);
   // Do something.
   Slate response = future.get();
 }

Returns

Type	Description
UnaryCallable<CreateSlateRequest,Slate>

createVodSession(CreateVodSessionRequest request)

public final VodSession createVodSession(CreateVodSessionRequest request)

Creates a client side playback VOD session and returns the full tracking and playback metadata of the session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   CreateVodSessionRequest request =
       CreateVodSessionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVodSession(VodSession.newBuilder().build())
           .build();
   VodSession response = videoStitcherServiceClient.createVodSession(request);
 }

Parameter

Name	Description
request	`CreateVodSessionRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
VodSession

createVodSession(LocationName parent, VodSession vodSession)

public final VodSession createVodSession(LocationName parent, VodSession vodSession)

Creates a client side playback VOD session and returns the full tracking and playback metadata of the session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   VodSession vodSession = VodSession.newBuilder().build();
   VodSession response = videoStitcherServiceClient.createVodSession(parent, vodSession);
 }

Parameters

Name	Description
parent	`LocationName` Required. The project and location in which the VOD session should be created, in the form of `projects/{project_number}/locations/{location}`.
vodSession	`VodSession` Required. Parameters for creating a session.

Returns

Type	Description
VodSession

createVodSession(String parent, VodSession vodSession)

public final VodSession createVodSession(String parent, VodSession vodSession)

Creates a client side playback VOD session and returns the full tracking and playback metadata of the session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   VodSession vodSession = VodSession.newBuilder().build();
   VodSession response = videoStitcherServiceClient.createVodSession(parent, vodSession);
 }

Parameters

Name	Description
parent	`String` Required. The project and location in which the VOD session should be created, in the form of `projects/{project_number}/locations/{location}`.
vodSession	`VodSession` Required. Parameters for creating a session.

Returns

Type	Description
VodSession

createVodSessionCallable()

public final UnaryCallable<CreateVodSessionRequest,VodSession> createVodSessionCallable()

Creates a client side playback VOD session and returns the full tracking and playback metadata of the session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   CreateVodSessionRequest request =
       CreateVodSessionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVodSession(VodSession.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateVodSessionRequest,VodSession>

deleteCdnKey(CdnKeyName name)

public final void deleteCdnKey(CdnKeyName name)

Deletes the specified CDN key.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   CdnKeyName name = CdnKeyName.of("[PROJECT]", "[LOCATION]", "[CDN_KEY]");
   videoStitcherServiceClient.deleteCdnKey(name);
 }

Parameter

Name	Description
name	`CdnKeyName` Required. The name of the CDN key to be deleted, in the form of `projects/{project_number}/locations/{location}/cdnKeys/{id}`.

deleteCdnKey(DeleteCdnKeyRequest request)

public final void deleteCdnKey(DeleteCdnKeyRequest request)

Deletes the specified CDN key.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   DeleteCdnKeyRequest request =
       DeleteCdnKeyRequest.newBuilder()
           .setName(CdnKeyName.of("[PROJECT]", "[LOCATION]", "[CDN_KEY]").toString())
           .build();
   videoStitcherServiceClient.deleteCdnKey(request);
 }

Parameter

Name	Description
request	`DeleteCdnKeyRequest` The request object containing all of the parameters for the API call.

deleteCdnKey(String name)

public final void deleteCdnKey(String name)

Deletes the specified CDN key.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String name = CdnKeyName.of("[PROJECT]", "[LOCATION]", "[CDN_KEY]").toString();
   videoStitcherServiceClient.deleteCdnKey(name);
 }

Parameter

Name	Description
name	`String` Required. The name of the CDN key to be deleted, in the form of `projects/{project_number}/locations/{location}/cdnKeys/{id}`.

deleteCdnKeyCallable()

public final UnaryCallable<DeleteCdnKeyRequest,Empty> deleteCdnKeyCallable()

Deletes the specified CDN key.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   DeleteCdnKeyRequest request =
       DeleteCdnKeyRequest.newBuilder()
           .setName(CdnKeyName.of("[PROJECT]", "[LOCATION]", "[CDN_KEY]").toString())
           .build();
   ApiFuture<Empty> future =
       videoStitcherServiceClient.deleteCdnKeyCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
UnaryCallable<DeleteCdnKeyRequest,Empty>

deleteSlate(DeleteSlateRequest request)

public final void deleteSlate(DeleteSlateRequest request)

Deletes the specified slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   DeleteSlateRequest request =
       DeleteSlateRequest.newBuilder()
           .setName(SlateName.of("[PROJECT]", "[LOCATION]", "[SLATE]").toString())
           .build();
   videoStitcherServiceClient.deleteSlate(request);
 }

Parameter

Name	Description
request	`DeleteSlateRequest` The request object containing all of the parameters for the API call.

deleteSlate(SlateName name)

public final void deleteSlate(SlateName name)

Deletes the specified slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   SlateName name = SlateName.of("[PROJECT]", "[LOCATION]", "[SLATE]");
   videoStitcherServiceClient.deleteSlate(name);
 }

Parameter

Name	Description
name	`SlateName` Required. The name of the slate to be deleted, in the form of `projects/{project_number}/locations/{location}/slates/{id}`.

deleteSlate(String name)

public final void deleteSlate(String name)

Deletes the specified slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String name = SlateName.of("[PROJECT]", "[LOCATION]", "[SLATE]").toString();
   videoStitcherServiceClient.deleteSlate(name);
 }

Parameter

Name	Description
name	`String` Required. The name of the slate to be deleted, in the form of `projects/{project_number}/locations/{location}/slates/{id}`.

deleteSlateCallable()

public final UnaryCallable<DeleteSlateRequest,Empty> deleteSlateCallable()

Deletes the specified slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   DeleteSlateRequest request =
       DeleteSlateRequest.newBuilder()
           .setName(SlateName.of("[PROJECT]", "[LOCATION]", "[SLATE]").toString())
           .build();
   ApiFuture<Empty> future =
       videoStitcherServiceClient.deleteSlateCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
UnaryCallable<DeleteSlateRequest,Empty>

getCdnKey(CdnKeyName name)

public final CdnKey getCdnKey(CdnKeyName name)

Returns the specified CDN key.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   CdnKeyName name = CdnKeyName.of("[PROJECT]", "[LOCATION]", "[CDN_KEY]");
   CdnKey response = videoStitcherServiceClient.getCdnKey(name);
 }

Parameter

Name	Description
name	`CdnKeyName` Required. The name of the CDN key to be retrieved, in the form of `projects/{project}/locations/{location}/cdnKeys/{id}`.

Returns

Type	Description
CdnKey

getCdnKey(GetCdnKeyRequest request)

public final CdnKey getCdnKey(GetCdnKeyRequest request)

Returns the specified CDN key.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetCdnKeyRequest request =
       GetCdnKeyRequest.newBuilder()
           .setName(CdnKeyName.of("[PROJECT]", "[LOCATION]", "[CDN_KEY]").toString())
           .build();
   CdnKey response = videoStitcherServiceClient.getCdnKey(request);
 }

Parameter

Name	Description
request	`GetCdnKeyRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
CdnKey

getCdnKey(String name)

public final CdnKey getCdnKey(String name)

Returns the specified CDN key.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String name = CdnKeyName.of("[PROJECT]", "[LOCATION]", "[CDN_KEY]").toString();
   CdnKey response = videoStitcherServiceClient.getCdnKey(name);
 }

Parameter

Name	Description
name	`String` Required. The name of the CDN key to be retrieved, in the form of `projects/{project}/locations/{location}/cdnKeys/{id}`.

Returns

Type	Description
CdnKey

getCdnKeyCallable()

public final UnaryCallable<GetCdnKeyRequest,CdnKey> getCdnKeyCallable()

Returns the specified CDN key.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetCdnKeyRequest request =
       GetCdnKeyRequest.newBuilder()
           .setName(CdnKeyName.of("[PROJECT]", "[LOCATION]", "[CDN_KEY]").toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetCdnKeyRequest,CdnKey>

getLiveAdTagDetail(GetLiveAdTagDetailRequest request)

public final LiveAdTagDetail getLiveAdTagDetail(GetLiveAdTagDetailRequest request)

Returns the specified ad tag detail for the specified live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetLiveAdTagDetailRequest request =
       GetLiveAdTagDetailRequest.newBuilder()
           .setName(
               LiveAdTagDetailName.of(
                       "[PROJECT]", "[LOCATION]", "[LIVE_SESSION]", "[LIVE_AD_TAG_DETAIL]")
                   .toString())
           .build();
   LiveAdTagDetail response = videoStitcherServiceClient.getLiveAdTagDetail(request);
 }

Parameter

Name	Description
request	`GetLiveAdTagDetailRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LiveAdTagDetail

getLiveAdTagDetail(LiveAdTagDetailName name)

public final LiveAdTagDetail getLiveAdTagDetail(LiveAdTagDetailName name)

Returns the specified ad tag detail for the specified live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   LiveAdTagDetailName name =
       LiveAdTagDetailName.of(
           "[PROJECT]", "[LOCATION]", "[LIVE_SESSION]", "[LIVE_AD_TAG_DETAIL]");
   LiveAdTagDetail response = videoStitcherServiceClient.getLiveAdTagDetail(name);
 }

Parameter

Name	Description
name	`LiveAdTagDetailName` Required. The resource name in the form of `projects/{project}/locations/{location}/liveSessions/{live_session}/liveAdTagDetails/{live_ad_tag_detail}`.

Returns

Type	Description
LiveAdTagDetail

getLiveAdTagDetail(String name)

public final LiveAdTagDetail getLiveAdTagDetail(String name)

Returns the specified ad tag detail for the specified live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String name =
       LiveAdTagDetailName.of(
               "[PROJECT]", "[LOCATION]", "[LIVE_SESSION]", "[LIVE_AD_TAG_DETAIL]")
           .toString();
   LiveAdTagDetail response = videoStitcherServiceClient.getLiveAdTagDetail(name);
 }

Parameter

Name	Description
name	`String` Required. The resource name in the form of `projects/{project}/locations/{location}/liveSessions/{live_session}/liveAdTagDetails/{live_ad_tag_detail}`.

Returns

Type	Description
LiveAdTagDetail

getLiveAdTagDetailCallable()

public final UnaryCallable<GetLiveAdTagDetailRequest,LiveAdTagDetail> getLiveAdTagDetailCallable()

Returns the specified ad tag detail for the specified live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetLiveAdTagDetailRequest request =
       GetLiveAdTagDetailRequest.newBuilder()
           .setName(
               LiveAdTagDetailName.of(
                       "[PROJECT]", "[LOCATION]", "[LIVE_SESSION]", "[LIVE_AD_TAG_DETAIL]")
                   .toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetLiveAdTagDetailRequest,LiveAdTagDetail>

getLiveSession(GetLiveSessionRequest request)

public final LiveSession getLiveSession(GetLiveSessionRequest request)

Returns the details for the specified live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetLiveSessionRequest request =
       GetLiveSessionRequest.newBuilder()
           .setName(LiveSessionName.of("[PROJECT]", "[LOCATION]", "[LIVE_SESSION]").toString())
           .build();
   LiveSession response = videoStitcherServiceClient.getLiveSession(request);
 }

Parameter

Name	Description
request	`GetLiveSessionRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LiveSession

getLiveSession(LiveSessionName name)

public final LiveSession getLiveSession(LiveSessionName name)

Returns the details for the specified live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   LiveSessionName name = LiveSessionName.of("[PROJECT]", "[LOCATION]", "[LIVE_SESSION]");
   LiveSession response = videoStitcherServiceClient.getLiveSession(name);
 }

Parameter

Name	Description
name	`LiveSessionName` Required. The name of the live session, in the form of `projects/{project_number}/locations/{location}/liveSessions/{id}`.

Returns

Type	Description
LiveSession

getLiveSession(String name)

public final LiveSession getLiveSession(String name)

Returns the details for the specified live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String name = LiveSessionName.of("[PROJECT]", "[LOCATION]", "[LIVE_SESSION]").toString();
   LiveSession response = videoStitcherServiceClient.getLiveSession(name);
 }

Parameter

Name	Description
name	`String` Required. The name of the live session, in the form of `projects/{project_number}/locations/{location}/liveSessions/{id}`.

Returns

Type	Description
LiveSession

getLiveSessionCallable()

public final UnaryCallable<GetLiveSessionRequest,LiveSession> getLiveSessionCallable()

Returns the details for the specified live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetLiveSessionRequest request =
       GetLiveSessionRequest.newBuilder()
           .setName(LiveSessionName.of("[PROJECT]", "[LOCATION]", "[LIVE_SESSION]").toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetLiveSessionRequest,LiveSession>

getSettings()

public final VideoStitcherServiceSettings getSettings()

Returns

Type	Description
VideoStitcherServiceSettings

getSlate(GetSlateRequest request)

public final Slate getSlate(GetSlateRequest request)

Returns the specified slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetSlateRequest request =
       GetSlateRequest.newBuilder()
           .setName(SlateName.of("[PROJECT]", "[LOCATION]", "[SLATE]").toString())
           .build();
   Slate response = videoStitcherServiceClient.getSlate(request);
 }

Parameter

Name	Description
request	`GetSlateRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
Slate

getSlate(SlateName name)

public final Slate getSlate(SlateName name)

Returns the specified slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   SlateName name = SlateName.of("[PROJECT]", "[LOCATION]", "[SLATE]");
   Slate response = videoStitcherServiceClient.getSlate(name);
 }

Parameter

Name	Description
name	`SlateName` Required. The name of the slate to be retrieved, of the slate, in the form of `projects/{project_number}/locations/{location}/slates/{id}`.

Returns

Type	Description
Slate

getSlate(String name)

public final Slate getSlate(String name)

Returns the specified slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String name = SlateName.of("[PROJECT]", "[LOCATION]", "[SLATE]").toString();
   Slate response = videoStitcherServiceClient.getSlate(name);
 }

Parameter

Name	Description
name	`String` Required. The name of the slate to be retrieved, of the slate, in the form of `projects/{project_number}/locations/{location}/slates/{id}`.

Returns

Type	Description
Slate

getSlateCallable()

public final UnaryCallable<GetSlateRequest,Slate> getSlateCallable()

Returns the specified slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetSlateRequest request =
       GetSlateRequest.newBuilder()
           .setName(SlateName.of("[PROJECT]", "[LOCATION]", "[SLATE]").toString())
           .build();
   ApiFuture<Slate> future = videoStitcherServiceClient.getSlateCallable().futureCall(request);
   // Do something.
   Slate response = future.get();
 }

Returns

Type	Description
UnaryCallable<GetSlateRequest,Slate>

getStub()

public VideoStitcherServiceStub getStub()

Returns

Type	Description
VideoStitcherServiceStub

getVodAdTagDetail(GetVodAdTagDetailRequest request)

public final VodAdTagDetail getVodAdTagDetail(GetVodAdTagDetailRequest request)

Returns the specified ad tag detail for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetVodAdTagDetailRequest request =
       GetVodAdTagDetailRequest.newBuilder()
           .setName(
               VodAdTagDetailName.of(
                       "[PROJECT]", "[LOCATION]", "[VOD_SESSION]", "[VOD_AD_TAG_DETAIL]")
                   .toString())
           .build();
   VodAdTagDetail response = videoStitcherServiceClient.getVodAdTagDetail(request);
 }

Parameter

Name	Description
request	`GetVodAdTagDetailRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
VodAdTagDetail

getVodAdTagDetail(VodAdTagDetailName name)

public final VodAdTagDetail getVodAdTagDetail(VodAdTagDetailName name)

Returns the specified ad tag detail for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   VodAdTagDetailName name =
       VodAdTagDetailName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]", "[VOD_AD_TAG_DETAIL]");
   VodAdTagDetail response = videoStitcherServiceClient.getVodAdTagDetail(name);
 }

Parameter

Name	Description
name	`VodAdTagDetailName` Required. The name of the ad tag detail for the specified VOD session, in the form of `projects/{project}/locations/{location}/vodSessions/{vod_session_id}/vodAdTagDetails/{vod_ad_tag_detail}`.

Returns

Type	Description
VodAdTagDetail

getVodAdTagDetail(String name)

public final VodAdTagDetail getVodAdTagDetail(String name)

Returns the specified ad tag detail for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String name =
       VodAdTagDetailName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]", "[VOD_AD_TAG_DETAIL]")
           .toString();
   VodAdTagDetail response = videoStitcherServiceClient.getVodAdTagDetail(name);
 }

Parameter

Name	Description
name	`String` Required. The name of the ad tag detail for the specified VOD session, in the form of `projects/{project}/locations/{location}/vodSessions/{vod_session_id}/vodAdTagDetails/{vod_ad_tag_detail}`.

Returns

Type	Description
VodAdTagDetail

getVodAdTagDetailCallable()

public final UnaryCallable<GetVodAdTagDetailRequest,VodAdTagDetail> getVodAdTagDetailCallable()

Returns the specified ad tag detail for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetVodAdTagDetailRequest request =
       GetVodAdTagDetailRequest.newBuilder()
           .setName(
               VodAdTagDetailName.of(
                       "[PROJECT]", "[LOCATION]", "[VOD_SESSION]", "[VOD_AD_TAG_DETAIL]")
                   .toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetVodAdTagDetailRequest,VodAdTagDetail>

getVodSession(GetVodSessionRequest request)

public final VodSession getVodSession(GetVodSessionRequest request)

Returns the full tracking, playback metadata, and relevant ad-ops logs for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetVodSessionRequest request =
       GetVodSessionRequest.newBuilder()
           .setName(VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]").toString())
           .build();
   VodSession response = videoStitcherServiceClient.getVodSession(request);
 }

Parameter

Name	Description
request	`GetVodSessionRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
VodSession

getVodSession(VodSessionName name)

public final VodSession getVodSession(VodSessionName name)

Returns the full tracking, playback metadata, and relevant ad-ops logs for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   VodSessionName name = VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]");
   VodSession response = videoStitcherServiceClient.getVodSession(name);
 }

Parameter

Name	Description
name	`VodSessionName` Required. The name of the VOD session to be retrieved, in the form of `projects/{project_number}/locations/{location}/vodSessions/{id}`.

Returns

Type	Description
VodSession

getVodSession(String name)

public final VodSession getVodSession(String name)

Returns the full tracking, playback metadata, and relevant ad-ops logs for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String name = VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]").toString();
   VodSession response = videoStitcherServiceClient.getVodSession(name);
 }

Parameter

Name	Description
name	`String` Required. The name of the VOD session to be retrieved, in the form of `projects/{project_number}/locations/{location}/vodSessions/{id}`.

Returns

Type	Description
VodSession

getVodSessionCallable()

public final UnaryCallable<GetVodSessionRequest,VodSession> getVodSessionCallable()

Returns the full tracking, playback metadata, and relevant ad-ops logs for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetVodSessionRequest request =
       GetVodSessionRequest.newBuilder()
           .setName(VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]").toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetVodSessionRequest,VodSession>

getVodStitchDetail(GetVodStitchDetailRequest request)

public final VodStitchDetail getVodStitchDetail(GetVodStitchDetailRequest request)

Returns the specified stitching information for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetVodStitchDetailRequest request =
       GetVodStitchDetailRequest.newBuilder()
           .setName(
               VodStitchDetailName.of(
                       "[PROJECT]", "[LOCATION]", "[VOD_SESSION]", "[VOD_STITCH_DETAIL]")
                   .toString())
           .build();
   VodStitchDetail response = videoStitcherServiceClient.getVodStitchDetail(request);
 }

Parameter

Name	Description
request	`GetVodStitchDetailRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
VodStitchDetail

getVodStitchDetail(VodStitchDetailName name)

public final VodStitchDetail getVodStitchDetail(VodStitchDetailName name)

Returns the specified stitching information for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   VodStitchDetailName name =
       VodStitchDetailName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]", "[VOD_STITCH_DETAIL]");
   VodStitchDetail response = videoStitcherServiceClient.getVodStitchDetail(name);
 }

Parameter

Name	Description
name	`VodStitchDetailName` Required. The name of the stitch detail in the specified VOD session, in the form of `projects/{project}/locations/{location}/vodSessions/{vod_session_id}/vodStitchDetails/{id}`.

Returns

Type	Description
VodStitchDetail

getVodStitchDetail(String name)

public final VodStitchDetail getVodStitchDetail(String name)

Returns the specified stitching information for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String name =
       VodStitchDetailName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]", "[VOD_STITCH_DETAIL]")
           .toString();
   VodStitchDetail response = videoStitcherServiceClient.getVodStitchDetail(name);
 }

Parameter

Name	Description
name	`String` Required. The name of the stitch detail in the specified VOD session, in the form of `projects/{project}/locations/{location}/vodSessions/{vod_session_id}/vodStitchDetails/{id}`.

Returns

Type	Description
VodStitchDetail

getVodStitchDetailCallable()

public final UnaryCallable<GetVodStitchDetailRequest,VodStitchDetail> getVodStitchDetailCallable()

Returns the specified stitching information for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   GetVodStitchDetailRequest request =
       GetVodStitchDetailRequest.newBuilder()
           .setName(
               VodStitchDetailName.of(
                       "[PROJECT]", "[LOCATION]", "[VOD_SESSION]", "[VOD_STITCH_DETAIL]")
                   .toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetVodStitchDetailRequest,VodStitchDetail>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listCdnKeys(ListCdnKeysRequest request)

public final VideoStitcherServiceClient.ListCdnKeysPagedResponse listCdnKeys(ListCdnKeysRequest request)

Lists all CDN keys in the specified project and location.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListCdnKeysRequest request =
       ListCdnKeysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (CdnKey element : videoStitcherServiceClient.listCdnKeys(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
request	`ListCdnKeysRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
VideoStitcherServiceClient.ListCdnKeysPagedResponse

listCdnKeys(LocationName parent)

public final VideoStitcherServiceClient.ListCdnKeysPagedResponse listCdnKeys(LocationName parent)

Lists all CDN keys in the specified project and location.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (CdnKey element : videoStitcherServiceClient.listCdnKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`LocationName` Required. The project that contains the list of CDN keys, in the form of `projects/{project_number}/locations/{location}`.

Returns

Type	Description
VideoStitcherServiceClient.ListCdnKeysPagedResponse

listCdnKeys(String parent)

public final VideoStitcherServiceClient.ListCdnKeysPagedResponse listCdnKeys(String parent)

Lists all CDN keys in the specified project and location.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (CdnKey element : videoStitcherServiceClient.listCdnKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The project that contains the list of CDN keys, in the form of `projects/{project_number}/locations/{location}`.

Returns

Type	Description
VideoStitcherServiceClient.ListCdnKeysPagedResponse

listCdnKeysCallable()

public final UnaryCallable<ListCdnKeysRequest,ListCdnKeysResponse> listCdnKeysCallable()

Lists all CDN keys in the specified project and location.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListCdnKeysRequest request =
       ListCdnKeysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListCdnKeysResponse response =
         videoStitcherServiceClient.listCdnKeysCallable().call(request);
     for (CdnKey element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListCdnKeysRequest,ListCdnKeysResponse>

listCdnKeysPagedCallable()

public final UnaryCallable<ListCdnKeysRequest,VideoStitcherServiceClient.ListCdnKeysPagedResponse> listCdnKeysPagedCallable()

Lists all CDN keys in the specified project and location.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListCdnKeysRequest request =
       ListCdnKeysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListCdnKeysRequest,ListCdnKeysPagedResponse>

listLiveAdTagDetails(ListLiveAdTagDetailsRequest request)

public final VideoStitcherServiceClient.ListLiveAdTagDetailsPagedResponse listLiveAdTagDetails(ListLiveAdTagDetailsRequest request)

Return the list of ad tag details for the specified live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListLiveAdTagDetailsRequest request =
       ListLiveAdTagDetailsRequest.newBuilder()
           .setParent(LiveSessionName.of("[PROJECT]", "[LOCATION]", "[LIVE_SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (LiveAdTagDetail element :
       videoStitcherServiceClient.listLiveAdTagDetails(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
request	`ListLiveAdTagDetailsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
VideoStitcherServiceClient.ListLiveAdTagDetailsPagedResponse

listLiveAdTagDetails(LiveSessionName parent)

public final VideoStitcherServiceClient.ListLiveAdTagDetailsPagedResponse listLiveAdTagDetails(LiveSessionName parent)

Return the list of ad tag details for the specified live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   LiveSessionName parent = LiveSessionName.of("[PROJECT]", "[LOCATION]", "[LIVE_SESSION]");
   for (LiveAdTagDetail element :
       videoStitcherServiceClient.listLiveAdTagDetails(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`LiveSessionName` Required. The resource parent in the form of `projects/{project}/locations/{location}/liveSessions/{live_session}`.

Returns

Type	Description
VideoStitcherServiceClient.ListLiveAdTagDetailsPagedResponse

listLiveAdTagDetails(String parent)

public final VideoStitcherServiceClient.ListLiveAdTagDetailsPagedResponse listLiveAdTagDetails(String parent)

Return the list of ad tag details for the specified live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String parent = LiveSessionName.of("[PROJECT]", "[LOCATION]", "[LIVE_SESSION]").toString();
   for (LiveAdTagDetail element :
       videoStitcherServiceClient.listLiveAdTagDetails(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The resource parent in the form of `projects/{project}/locations/{location}/liveSessions/{live_session}`.

Returns

Type	Description
VideoStitcherServiceClient.ListLiveAdTagDetailsPagedResponse

listLiveAdTagDetailsCallable()

public final UnaryCallable<ListLiveAdTagDetailsRequest,ListLiveAdTagDetailsResponse> listLiveAdTagDetailsCallable()

Return the list of ad tag details for the specified live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListLiveAdTagDetailsRequest request =
       ListLiveAdTagDetailsRequest.newBuilder()
           .setParent(LiveSessionName.of("[PROJECT]", "[LOCATION]", "[LIVE_SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLiveAdTagDetailsResponse response =
         videoStitcherServiceClient.listLiveAdTagDetailsCallable().call(request);
     for (LiveAdTagDetail element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListLiveAdTagDetailsRequest,ListLiveAdTagDetailsResponse>

listLiveAdTagDetailsPagedCallable()

public final UnaryCallable<ListLiveAdTagDetailsRequest,VideoStitcherServiceClient.ListLiveAdTagDetailsPagedResponse> listLiveAdTagDetailsPagedCallable()

Return the list of ad tag details for the specified live session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListLiveAdTagDetailsRequest request =
       ListLiveAdTagDetailsRequest.newBuilder()
           .setParent(LiveSessionName.of("[PROJECT]", "[LOCATION]", "[LIVE_SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListLiveAdTagDetailsRequest,ListLiveAdTagDetailsPagedResponse>

listSlates(ListSlatesRequest request)

public final VideoStitcherServiceClient.ListSlatesPagedResponse listSlates(ListSlatesRequest request)

Lists all slates in the specified project and location.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListSlatesRequest request =
       ListSlatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Slate element : videoStitcherServiceClient.listSlates(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
request	`ListSlatesRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
VideoStitcherServiceClient.ListSlatesPagedResponse

listSlates(LocationName parent)

public final VideoStitcherServiceClient.ListSlatesPagedResponse listSlates(LocationName parent)

Lists all slates in the specified project and location.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Slate element : videoStitcherServiceClient.listSlates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`LocationName` Required. The project to list slates, in the form of `projects/{project_number}`.

Returns

Type	Description
VideoStitcherServiceClient.ListSlatesPagedResponse

listSlates(String parent)

public final VideoStitcherServiceClient.ListSlatesPagedResponse listSlates(String parent)

Lists all slates in the specified project and location.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Slate element : videoStitcherServiceClient.listSlates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The project to list slates, in the form of `projects/{project_number}`.

Returns

Type	Description
VideoStitcherServiceClient.ListSlatesPagedResponse

listSlatesCallable()

public final UnaryCallable<ListSlatesRequest,ListSlatesResponse> listSlatesCallable()

Lists all slates in the specified project and location.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListSlatesRequest request =
       ListSlatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListSlatesResponse response = videoStitcherServiceClient.listSlatesCallable().call(request);
     for (Slate element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListSlatesRequest,ListSlatesResponse>

listSlatesPagedCallable()

public final UnaryCallable<ListSlatesRequest,VideoStitcherServiceClient.ListSlatesPagedResponse> listSlatesPagedCallable()

Lists all slates in the specified project and location.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListSlatesRequest request =
       ListSlatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Slate> future =
       videoStitcherServiceClient.listSlatesPagedCallable().futureCall(request);
   // Do something.
   for (Slate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListSlatesRequest,ListSlatesPagedResponse>

listVodAdTagDetails(ListVodAdTagDetailsRequest request)

public final VideoStitcherServiceClient.ListVodAdTagDetailsPagedResponse listVodAdTagDetails(ListVodAdTagDetailsRequest request)

Return the list of ad tag details for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListVodAdTagDetailsRequest request =
       ListVodAdTagDetailsRequest.newBuilder()
           .setParent(VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (VodAdTagDetail element :
       videoStitcherServiceClient.listVodAdTagDetails(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
request	`ListVodAdTagDetailsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
VideoStitcherServiceClient.ListVodAdTagDetailsPagedResponse

listVodAdTagDetails(VodSessionName parent)

public final VideoStitcherServiceClient.ListVodAdTagDetailsPagedResponse listVodAdTagDetails(VodSessionName parent)

Return the list of ad tag details for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   VodSessionName parent = VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]");
   for (VodAdTagDetail element :
       videoStitcherServiceClient.listVodAdTagDetails(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`VodSessionName` Required. The VOD session which the ad tag details belong to, in the form of `projects/{project}/locations/{location}/vodSessions/{vod_session_id}`.

Returns

Type	Description
VideoStitcherServiceClient.ListVodAdTagDetailsPagedResponse

listVodAdTagDetails(String parent)

public final VideoStitcherServiceClient.ListVodAdTagDetailsPagedResponse listVodAdTagDetails(String parent)

Return the list of ad tag details for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String parent = VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]").toString();
   for (VodAdTagDetail element :
       videoStitcherServiceClient.listVodAdTagDetails(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The VOD session which the ad tag details belong to, in the form of `projects/{project}/locations/{location}/vodSessions/{vod_session_id}`.

Returns

Type	Description
VideoStitcherServiceClient.ListVodAdTagDetailsPagedResponse

listVodAdTagDetailsCallable()

public final UnaryCallable<ListVodAdTagDetailsRequest,ListVodAdTagDetailsResponse> listVodAdTagDetailsCallable()

Return the list of ad tag details for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListVodAdTagDetailsRequest request =
       ListVodAdTagDetailsRequest.newBuilder()
           .setParent(VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListVodAdTagDetailsResponse response =
         videoStitcherServiceClient.listVodAdTagDetailsCallable().call(request);
     for (VodAdTagDetail element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListVodAdTagDetailsRequest,ListVodAdTagDetailsResponse>

listVodAdTagDetailsPagedCallable()

public final UnaryCallable<ListVodAdTagDetailsRequest,VideoStitcherServiceClient.ListVodAdTagDetailsPagedResponse> listVodAdTagDetailsPagedCallable()

Return the list of ad tag details for the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListVodAdTagDetailsRequest request =
       ListVodAdTagDetailsRequest.newBuilder()
           .setParent(VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListVodAdTagDetailsRequest,ListVodAdTagDetailsPagedResponse>

listVodStitchDetails(ListVodStitchDetailsRequest request)

public final VideoStitcherServiceClient.ListVodStitchDetailsPagedResponse listVodStitchDetails(ListVodStitchDetailsRequest request)

Returns a list of detailed stitching information of the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListVodStitchDetailsRequest request =
       ListVodStitchDetailsRequest.newBuilder()
           .setParent(VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (VodStitchDetail element :
       videoStitcherServiceClient.listVodStitchDetails(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
request	`ListVodStitchDetailsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
VideoStitcherServiceClient.ListVodStitchDetailsPagedResponse

listVodStitchDetails(VodSessionName parent)

public final VideoStitcherServiceClient.ListVodStitchDetailsPagedResponse listVodStitchDetails(VodSessionName parent)

Returns a list of detailed stitching information of the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   VodSessionName parent = VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]");
   for (VodStitchDetail element :
       videoStitcherServiceClient.listVodStitchDetails(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`VodSessionName` Required. The VOD session where the stitch details belong to, in the form of `projects/{project}/locations/{location}/vodSessions/{id}`.

Returns

Type	Description
VideoStitcherServiceClient.ListVodStitchDetailsPagedResponse

listVodStitchDetails(String parent)

public final VideoStitcherServiceClient.ListVodStitchDetailsPagedResponse listVodStitchDetails(String parent)

Returns a list of detailed stitching information of the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   String parent = VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]").toString();
   for (VodStitchDetail element :
       videoStitcherServiceClient.listVodStitchDetails(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The VOD session where the stitch details belong to, in the form of `projects/{project}/locations/{location}/vodSessions/{id}`.

Returns

Type	Description
VideoStitcherServiceClient.ListVodStitchDetailsPagedResponse

listVodStitchDetailsCallable()

public final UnaryCallable<ListVodStitchDetailsRequest,ListVodStitchDetailsResponse> listVodStitchDetailsCallable()

Returns a list of detailed stitching information of the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListVodStitchDetailsRequest request =
       ListVodStitchDetailsRequest.newBuilder()
           .setParent(VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListVodStitchDetailsResponse response =
         videoStitcherServiceClient.listVodStitchDetailsCallable().call(request);
     for (VodStitchDetail element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListVodStitchDetailsRequest,ListVodStitchDetailsResponse>

listVodStitchDetailsPagedCallable()

public final UnaryCallable<ListVodStitchDetailsRequest,VideoStitcherServiceClient.ListVodStitchDetailsPagedResponse> listVodStitchDetailsPagedCallable()

Returns a list of detailed stitching information of the specified VOD session.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   ListVodStitchDetailsRequest request =
       ListVodStitchDetailsRequest.newBuilder()
           .setParent(VodSessionName.of("[PROJECT]", "[LOCATION]", "[VOD_SESSION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListVodStitchDetailsRequest,ListVodStitchDetailsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateCdnKey(CdnKey cdnKey, FieldMask updateMask)

public final CdnKey updateCdnKey(CdnKey cdnKey, FieldMask updateMask)

Updates the specified CDN key. Only update fields specified in the call method body.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   CdnKey cdnKey = CdnKey.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   CdnKey response = videoStitcherServiceClient.updateCdnKey(cdnKey, updateMask);
 }

Parameters

Name	Description
cdnKey	`CdnKey` Required. The CDN key resource which replaces the resource on the server.
updateMask	`FieldMask` Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Returns

Type	Description
CdnKey

updateCdnKey(UpdateCdnKeyRequest request)

public final CdnKey updateCdnKey(UpdateCdnKeyRequest request)

Updates the specified CDN key. Only update fields specified in the call method body.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   UpdateCdnKeyRequest request =
       UpdateCdnKeyRequest.newBuilder()
           .setCdnKey(CdnKey.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   CdnKey response = videoStitcherServiceClient.updateCdnKey(request);
 }

Parameter

Name	Description
request	`UpdateCdnKeyRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
CdnKey

updateCdnKeyCallable()

public final UnaryCallable<UpdateCdnKeyRequest,CdnKey> updateCdnKeyCallable()

Updates the specified CDN key. Only update fields specified in the call method body.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   UpdateCdnKeyRequest request =
       UpdateCdnKeyRequest.newBuilder()
           .setCdnKey(CdnKey.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UpdateCdnKeyRequest,CdnKey>

updateSlate(Slate slate, FieldMask updateMask)

public final Slate updateSlate(Slate slate, FieldMask updateMask)

Updates the specified slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   Slate slate = Slate.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Slate response = videoStitcherServiceClient.updateSlate(slate, updateMask);
 }

Parameters

Name	Description
slate	`Slate` Required. The resource with updated fields.
updateMask	`FieldMask` Required. The update mask which specifies fields which should be updated.

Returns

Type	Description
Slate

updateSlate(UpdateSlateRequest request)

public final Slate updateSlate(UpdateSlateRequest request)

Updates the specified slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   UpdateSlateRequest request =
       UpdateSlateRequest.newBuilder()
           .setSlate(Slate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Slate response = videoStitcherServiceClient.updateSlate(request);
 }

Parameter

Name	Description
request	`UpdateSlateRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
Slate

updateSlateCallable()

public final UnaryCallable<UpdateSlateRequest,Slate> updateSlateCallable()

Updates the specified slate.

Sample code:


 try (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   UpdateSlateRequest request =
       UpdateSlateRequest.newBuilder()
           .setSlate(Slate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Slate> future =
       videoStitcherServiceClient.updateSlateCallable().futureCall(request);
   // Do something.
   Slate response = future.get();
 }

Returns

Type	Description
UnaryCallable<UpdateSlateRequest,Slate>