/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/video/stitcher/v1/sessions.proto
package com.google.cloud.video.stitcher.v1;
public interface VodSessionOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.video.stitcher.v1.VodSession)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The name of the VOD session, in the form of
* `projects/{project_number}/locations/{location}/vodSessions/{id}`.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. The name of the VOD session, in the form of
* `projects/{project_number}/locations/{location}/vodSessions/{id}`.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. Metadata of what was stitched into the content.
*
*
*
* .google.cloud.video.stitcher.v1.Interstitials interstitials = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the interstitials field is set.
*/
boolean hasInterstitials();
/**
*
*
*
* Output only. Metadata of what was stitched into the content.
*
*
*
* .google.cloud.video.stitcher.v1.Interstitials interstitials = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The interstitials.
*/
com.google.cloud.video.stitcher.v1.Interstitials getInterstitials();
/**
*
*
*
* Output only. Metadata of what was stitched into the content.
*
*
*
* .google.cloud.video.stitcher.v1.Interstitials interstitials = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.video.stitcher.v1.InterstitialsOrBuilder getInterstitialsOrBuilder();
/**
*
*
*
* Output only. The playback URI of the stitched content.
*
*
* string play_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The playUri.
*/
java.lang.String getPlayUri();
/**
*
*
*
* Output only. The playback URI of the stitched content.
*
*
* string play_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for playUri.
*/
com.google.protobuf.ByteString getPlayUriBytes();
/**
*
*
*
* Required. URI of the media to stitch.
*
*
* string source_uri = 5 [(.google.api.field_behavior) = REQUIRED];
*
* @return The sourceUri.
*/
java.lang.String getSourceUri();
/**
*
*
*
* Required. URI of the media to stitch.
*
*
* string source_uri = 5 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for sourceUri.
*/
com.google.protobuf.ByteString getSourceUriBytes();
/**
*
*
*
* Required. Ad tag URI.
*
*
* string ad_tag_uri = 6 [(.google.api.field_behavior) = REQUIRED];
*
* @return The adTagUri.
*/
java.lang.String getAdTagUri();
/**
*
*
*
* Required. Ad tag URI.
*
*
* string ad_tag_uri = 6 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for adTagUri.
*/
com.google.protobuf.ByteString getAdTagUriBytes();
/**
*
*
*
* Key value pairs for ad tag macro replacement. If the
* specified ad tag URI has macros, this field provides the mapping
* to the value that will replace the macro in the ad tag URI.
* Macros are designated by square brackets.
* For example:
* Ad tag URI: `"https://doubleclick.google.com/ad/1?geo_id=[geoId]"`
* Ad tag macro map: `{"geoId": "123"}`
* Fully qualified ad tag:
* `"`https://doubleclick.google.com/ad/1?geo_id=123"`
*
*
* map<string, string> ad_tag_macro_map = 7;
*/
int getAdTagMacroMapCount();
/**
*
*
*
* Key value pairs for ad tag macro replacement. If the
* specified ad tag URI has macros, this field provides the mapping
* to the value that will replace the macro in the ad tag URI.
* Macros are designated by square brackets.
* For example:
* Ad tag URI: `"https://doubleclick.google.com/ad/1?geo_id=[geoId]"`
* Ad tag macro map: `{"geoId": "123"}`
* Fully qualified ad tag:
* `"`https://doubleclick.google.com/ad/1?geo_id=123"`
*
*
* map<string, string> ad_tag_macro_map = 7;
*/
boolean containsAdTagMacroMap(java.lang.String key);
/** Use {@link #getAdTagMacroMapMap()} instead. */
@java.lang.Deprecated
java.util.Map getAdTagMacroMap();
/**
*
*
*
* Key value pairs for ad tag macro replacement. If the
* specified ad tag URI has macros, this field provides the mapping
* to the value that will replace the macro in the ad tag URI.
* Macros are designated by square brackets.
* For example:
* Ad tag URI: `"https://doubleclick.google.com/ad/1?geo_id=[geoId]"`
* Ad tag macro map: `{"geoId": "123"}`
* Fully qualified ad tag:
* `"`https://doubleclick.google.com/ad/1?geo_id=123"`
*
*
* map<string, string> ad_tag_macro_map = 7;
*/
java.util.Map getAdTagMacroMapMap();
/**
*
*
*
* Key value pairs for ad tag macro replacement. If the
* specified ad tag URI has macros, this field provides the mapping
* to the value that will replace the macro in the ad tag URI.
* Macros are designated by square brackets.
* For example:
* Ad tag URI: `"https://doubleclick.google.com/ad/1?geo_id=[geoId]"`
* Ad tag macro map: `{"geoId": "123"}`
* Fully qualified ad tag:
* `"`https://doubleclick.google.com/ad/1?geo_id=123"`
*
*
* map<string, string> ad_tag_macro_map = 7;
*/
/* nullable */
java.lang.String getAdTagMacroMapOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Key value pairs for ad tag macro replacement. If the
* specified ad tag URI has macros, this field provides the mapping
* to the value that will replace the macro in the ad tag URI.
* Macros are designated by square brackets.
* For example:
* Ad tag URI: `"https://doubleclick.google.com/ad/1?geo_id=[geoId]"`
* Ad tag macro map: `{"geoId": "123"}`
* Fully qualified ad tag:
* `"`https://doubleclick.google.com/ad/1?geo_id=123"`
*
*
* map<string, string> ad_tag_macro_map = 7;
*/
java.lang.String getAdTagMacroMapOrThrow(java.lang.String key);
/**
*
*
*
* Indicates whether client side ad tracking is enabled. If client
* side ad tracking is enabled, then the client player is expected
* to trigger playback and activity events itself.
* If this is set to false, server side ad tracking is enabled,
* causing the Video Stitcher service will trigger playback events
* on behalf of the client player.
*
*
* bool client_ad_tracking = 8;
*
* @return The clientAdTracking.
*/
boolean getClientAdTracking();
/**
*
*
*
* Additional options that affect the output of the manifest.
*
*
* .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;
*
* @return Whether the manifestOptions field is set.
*/
boolean hasManifestOptions();
/**
*
*
*
* Additional options that affect the output of the manifest.
*
*
* .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;
*
* @return The manifestOptions.
*/
com.google.cloud.video.stitcher.v1.ManifestOptions getManifestOptions();
/**
*
*
*
* Additional options that affect the output of the manifest.
*
*
* .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 9;
*/
com.google.cloud.video.stitcher.v1.ManifestOptionsOrBuilder getManifestOptionsOrBuilder();
/**
*
*
*
* Output only. The generated ID of the VodSession's source media.
*
*
* string asset_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The assetId.
*/
java.lang.String getAssetId();
/**
*
*
*
* Output only. The generated ID of the VodSession's source media.
*
*
* string asset_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for assetId.
*/
com.google.protobuf.ByteString getAssetIdBytes();
}