/*
 * Copyright 2023 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/companions.proto

package com.google.cloud.video.stitcher.v1;

public interface CompanionOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.video.stitcher.v1.Companion)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * <pre>
   * The IFrame ad resource associated with the companion ad.
   * </pre>
   *
   * <code>.google.cloud.video.stitcher.v1.IframeAdResource iframe_ad_resource = 10;</code>
   *
   * @return Whether the iframeAdResource field is set.
   */
  boolean hasIframeAdResource();
  /**
   *
   *
   * <pre>
   * The IFrame ad resource associated with the companion ad.
   * </pre>
   *
   * <code>.google.cloud.video.stitcher.v1.IframeAdResource iframe_ad_resource = 10;</code>
   *
   * @return The iframeAdResource.
   */
  com.google.cloud.video.stitcher.v1.IframeAdResource getIframeAdResource();
  /**
   *
   *
   * <pre>
   * The IFrame ad resource associated with the companion ad.
   * </pre>
   *
   * <code>.google.cloud.video.stitcher.v1.IframeAdResource iframe_ad_resource = 10;</code>
   */
  com.google.cloud.video.stitcher.v1.IframeAdResourceOrBuilder getIframeAdResourceOrBuilder();

  /**
   *
   *
   * <pre>
   * The static ad resource associated with the companion ad.
   * </pre>
   *
   * <code>.google.cloud.video.stitcher.v1.StaticAdResource static_ad_resource = 11;</code>
   *
   * @return Whether the staticAdResource field is set.
   */
  boolean hasStaticAdResource();
  /**
   *
   *
   * <pre>
   * The static ad resource associated with the companion ad.
   * </pre>
   *
   * <code>.google.cloud.video.stitcher.v1.StaticAdResource static_ad_resource = 11;</code>
   *
   * @return The staticAdResource.
   */
  com.google.cloud.video.stitcher.v1.StaticAdResource getStaticAdResource();
  /**
   *
   *
   * <pre>
   * The static ad resource associated with the companion ad.
   * </pre>
   *
   * <code>.google.cloud.video.stitcher.v1.StaticAdResource static_ad_resource = 11;</code>
   */
  com.google.cloud.video.stitcher.v1.StaticAdResourceOrBuilder getStaticAdResourceOrBuilder();

  /**
   *
   *
   * <pre>
   * The HTML ad resource associated with the companion ad.
   * </pre>
   *
   * <code>.google.cloud.video.stitcher.v1.HtmlAdResource html_ad_resource = 12;</code>
   *
   * @return Whether the htmlAdResource field is set.
   */
  boolean hasHtmlAdResource();
  /**
   *
   *
   * <pre>
   * The HTML ad resource associated with the companion ad.
   * </pre>
   *
   * <code>.google.cloud.video.stitcher.v1.HtmlAdResource html_ad_resource = 12;</code>
   *
   * @return The htmlAdResource.
   */
  com.google.cloud.video.stitcher.v1.HtmlAdResource getHtmlAdResource();
  /**
   *
   *
   * <pre>
   * The HTML ad resource associated with the companion ad.
   * </pre>
   *
   * <code>.google.cloud.video.stitcher.v1.HtmlAdResource html_ad_resource = 12;</code>
   */
  com.google.cloud.video.stitcher.v1.HtmlAdResourceOrBuilder getHtmlAdResourceOrBuilder();

  /**
   *
   *
   * <pre>
   * The API necessary to communicate with the creative if available.
   * </pre>
   *
   * <code>string api_framework = 1;</code>
   *
   * @return The apiFramework.
   */
  java.lang.String getApiFramework();
  /**
   *
   *
   * <pre>
   * The API necessary to communicate with the creative if available.
   * </pre>
   *
   * <code>string api_framework = 1;</code>
   *
   * @return The bytes for apiFramework.
   */
  com.google.protobuf.ByteString getApiFrameworkBytes();

  /**
   *
   *
   * <pre>
   * The pixel height of the placement slot for the intended creative.
   * </pre>
   *
   * <code>int32 height_px = 2;</code>
   *
   * @return The heightPx.
   */
  int getHeightPx();

  /**
   *
   *
   * <pre>
   * The pixel width of the placement slot for the intended creative.
   * </pre>
   *
   * <code>int32 width_px = 3;</code>
   *
   * @return The widthPx.
   */
  int getWidthPx();

  /**
   *
   *
   * <pre>
   * The pixel height of the creative.
   * </pre>
   *
   * <code>int32 asset_height_px = 4;</code>
   *
   * @return The assetHeightPx.
   */
  int getAssetHeightPx();

  /**
   *
   *
   * <pre>
   * The maximum pixel height of the creative in its expanded state.
   * </pre>
   *
   * <code>int32 expanded_height_px = 5;</code>
   *
   * @return The expandedHeightPx.
   */
  int getExpandedHeightPx();

  /**
   *
   *
   * <pre>
   * The pixel width of the creative.
   * </pre>
   *
   * <code>int32 asset_width_px = 6;</code>
   *
   * @return The assetWidthPx.
   */
  int getAssetWidthPx();

  /**
   *
   *
   * <pre>
   * The maximum pixel width of the creative in its expanded state.
   * </pre>
   *
   * <code>int32 expanded_width_px = 7;</code>
   *
   * @return The expandedWidthPx.
   */
  int getExpandedWidthPx();

  /**
   *
   *
   * <pre>
   * The ID used to identify the desired placement on a publisher's page.
   * Values to be used should be discussed between publishers and
   * advertisers.
   * </pre>
   *
   * <code>string ad_slot_id = 8;</code>
   *
   * @return The adSlotId.
   */
  java.lang.String getAdSlotId();
  /**
   *
   *
   * <pre>
   * The ID used to identify the desired placement on a publisher's page.
   * Values to be used should be discussed between publishers and
   * advertisers.
   * </pre>
   *
   * <code>string ad_slot_id = 8;</code>
   *
   * @return The bytes for adSlotId.
   */
  com.google.protobuf.ByteString getAdSlotIdBytes();

  /**
   *
   *
   * <pre>
   * The list of tracking events for the companion.
   * </pre>
   *
   * <code>repeated .google.cloud.video.stitcher.v1.Event events = 9;</code>
   */
  java.util.List<com.google.cloud.video.stitcher.v1.Event> getEventsList();
  /**
   *
   *
   * <pre>
   * The list of tracking events for the companion.
   * </pre>
   *
   * <code>repeated .google.cloud.video.stitcher.v1.Event events = 9;</code>
   */
  com.google.cloud.video.stitcher.v1.Event getEvents(int index);
  /**
   *
   *
   * <pre>
   * The list of tracking events for the companion.
   * </pre>
   *
   * <code>repeated .google.cloud.video.stitcher.v1.Event events = 9;</code>
   */
  int getEventsCount();
  /**
   *
   *
   * <pre>
   * The list of tracking events for the companion.
   * </pre>
   *
   * <code>repeated .google.cloud.video.stitcher.v1.Event events = 9;</code>
   */
  java.util.List<? extends com.google.cloud.video.stitcher.v1.EventOrBuilder>
      getEventsOrBuilderList();
  /**
   *
   *
   * <pre>
   * The list of tracking events for the companion.
   * </pre>
   *
   * <code>repeated .google.cloud.video.stitcher.v1.Event events = 9;</code>
   */
  com.google.cloud.video.stitcher.v1.EventOrBuilder getEventsOrBuilder(int index);

  com.google.cloud.video.stitcher.v1.Companion.AdResourceCase getAdResourceCase();
}
