All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.api.services.playmoviespartner.model.Avail Maven / Gradle / Ivy

/*
 * Copyright 2010 Google Inc.
 *
 * 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
 *
 * http://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.
 */
/*
 * This code was generated by https://code.google.com/p/google-apis-client-generator/
 * (build: 2017-02-15 17:18:02 UTC)
 * on 2017-08-10 at 21:12:03 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.playmoviespartner.model;

/**
 * An Avail describes the Availability Window of a specific Edit in a given country, which means the
 * period Google is allowed to sell or rent the Edit.
 *
 * Avails are exposed in EMA format Version 1.6b (available at http://www.movielabs.com/md/avails/)
 *
 * Studios can see the Avails for the Titles they own. Post-production houses cannot see any Avails.
 *
 * 

This is the Java data model class that specifies how to parse/serialize into the JSON that is * transmitted over HTTP when working with the Google Play Movies Partner API. For a detailed * explanation see: * http://code.google.com/p/google-http-java-client/wiki/JSON *

* * @author Google, Inc. */ @SuppressWarnings("javadoc") public final class Avail extends com.google.api.client.json.GenericJson { /** * Other identifier referring to the Edit, as defined by partner. Example: "GOOGLER_2006" * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String altId; /** * ID internally generated by Google to uniquely identify an Avail. Not part of EMA Specs. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String availId; /** * Communicating an exempt category as defined by FCC regulations. It is not required for non-US * Avails. Example: "1" * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String captionExemption; /** * Communicating if caption file will be delivered. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.Boolean captionIncluded; /** * Title Identifier. This should be the Title Level EIDR. Example: "10.5240/1489-49A2-3956-4B2D- * FE16-5". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String contentId; /** * The name of the studio that owns the Edit referred in the Avail. This is the equivalent of * `studio_name` in other resources, but it follows the EMA nomenclature. Example: "Google Films". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String displayName; /** * Manifestation Identifier. This should be the Manifestation Level EIDR. Example: * "10.2340/1489-49A2-3956-4B2D-FE16-7" * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String encodeId; /** * End of term in YYYY-MM-DD format in the timezone of the country of the Avail. "Open" if no end * date is available. Example: "2019-02-17" * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String end; /** * Other identifier referring to the episode, as defined by partner. Only available on TV avails. * Example: "rs_googlers_s1_3". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String episodeAltId; /** * The number assigned to the episode within a season. Only available on TV Avails. Example: "3". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String episodeNumber; /** * OPTIONAL.TV Only. Title used by involved parties to refer to this episode. Only available on TV * Avails. Example: "Coding at Google". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String episodeTitleInternalAlias; /** * Indicates the format profile covered by the transaction. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String formatProfile; /** * Type of transaction. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String licenseType; /** * Name of the post-production houses that manage the Avail. Not part of EMA Specs. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.util.List pphNames; /** * Type of pricing that should be applied to this Avail based on how the partner classify them. * Example: "Tier", "WSP", "SRP", or "Category". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String priceType; /** * Value to be applied to the pricing type. Example: "4" or "2.99" * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String priceValue; /** * Edit Identifier. This should be the Edit Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D- * FE16-6" * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String productId; /** * Value representing the rating reason. Rating reasons should be formatted as per [EMA ratings * spec](http://www.movielabs.com/md/ratings/) and comma-separated for inclusion of multiple * reasons. Example: "L, S, V" * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String ratingReason; /** * Rating system applied to the version of title within territory of Avail. Rating systems should * be formatted as per [EMA ratings spec](http://www.movielabs.com/md/ratings/) Example: "MPAA" * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String ratingSystem; /** * Value representing the rating. Ratings should be formatted as per * http://www.movielabs.com/md/ratings/ Example: "PG" * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String ratingValue; /** * Release date of the Title in earliest released territory. Typically it is just the year, but it * is free-form as per EMA spec. Examples: "1979", "Oct 2014" * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String releaseDate; /** * Other identifier referring to the season, as defined by partner. Only available on TV avails. * Example: "rs_googlers_s1". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String seasonAltId; /** * The number assigned to the season within a series. Only available on TV Avails. Example: "1". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String seasonNumber; /** * Title used by involved parties to refer to this season. Only available on TV Avails. Example: * "Googlers, The". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String seasonTitleInternalAlias; /** * Other identifier referring to the series, as defined by partner. Only available on TV avails. * Example: "rs_googlers". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String seriesAltId; /** * Title used by involved parties to refer to this series. Only available on TV Avails. Example: * "Googlers, The". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String seriesTitleInternalAlias; /** * Start of term in YYYY-MM-DD format in the timezone of the country of the Avail. Example: * "2013-05-14". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String start; /** * Spoken language of the intended audience. Language shall be encoded in accordance with RFC * 5646. Example: "fr". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String storeLanguage; /** * First date an Edit could be publically announced as becoming available at a specific future * date in territory of Avail. *Not* the Avail start date or pre-order start date. Format is YYYY- * MM-DD. Only available for pre-orders. Example: "2012-12-10" * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String suppressionLiftDate; /** * ISO 3166-1 alpha-2 country code for the country or territory of this Avail. For Avails, we use * Territory in lieu of Country to comply with EMA specifications. But please note that Territory * and Country identify the same thing. Example: "US". * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String territory; /** * Title used by involved parties to refer to this content. Example: "Googlers, The". Only * available on Movie Avails. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String titleInternalAlias; /** * Google-generated ID identifying the video linked to this Avail, once delivered. Not part of EMA * Specs. Example: 'gtry456_xc' * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String videoId; /** * Work type as enumerated in EMA. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String workType; /** * Other identifier referring to the Edit, as defined by partner. Example: "GOOGLER_2006" * @return value or {@code null} for none */ public java.lang.String getAltId() { return altId; } /** * Other identifier referring to the Edit, as defined by partner. Example: "GOOGLER_2006" * @param altId altId or {@code null} for none */ public Avail setAltId(java.lang.String altId) { this.altId = altId; return this; } /** * ID internally generated by Google to uniquely identify an Avail. Not part of EMA Specs. * @return value or {@code null} for none */ public java.lang.String getAvailId() { return availId; } /** * ID internally generated by Google to uniquely identify an Avail. Not part of EMA Specs. * @param availId availId or {@code null} for none */ public Avail setAvailId(java.lang.String availId) { this.availId = availId; return this; } /** * Communicating an exempt category as defined by FCC regulations. It is not required for non-US * Avails. Example: "1" * @return value or {@code null} for none */ public java.lang.String getCaptionExemption() { return captionExemption; } /** * Communicating an exempt category as defined by FCC regulations. It is not required for non-US * Avails. Example: "1" * @param captionExemption captionExemption or {@code null} for none */ public Avail setCaptionExemption(java.lang.String captionExemption) { this.captionExemption = captionExemption; return this; } /** * Communicating if caption file will be delivered. * @return value or {@code null} for none */ public java.lang.Boolean getCaptionIncluded() { return captionIncluded; } /** * Communicating if caption file will be delivered. * @param captionIncluded captionIncluded or {@code null} for none */ public Avail setCaptionIncluded(java.lang.Boolean captionIncluded) { this.captionIncluded = captionIncluded; return this; } /** * Title Identifier. This should be the Title Level EIDR. Example: "10.5240/1489-49A2-3956-4B2D- * FE16-5". * @return value or {@code null} for none */ public java.lang.String getContentId() { return contentId; } /** * Title Identifier. This should be the Title Level EIDR. Example: "10.5240/1489-49A2-3956-4B2D- * FE16-5". * @param contentId contentId or {@code null} for none */ public Avail setContentId(java.lang.String contentId) { this.contentId = contentId; return this; } /** * The name of the studio that owns the Edit referred in the Avail. This is the equivalent of * `studio_name` in other resources, but it follows the EMA nomenclature. Example: "Google Films". * @return value or {@code null} for none */ public java.lang.String getDisplayName() { return displayName; } /** * The name of the studio that owns the Edit referred in the Avail. This is the equivalent of * `studio_name` in other resources, but it follows the EMA nomenclature. Example: "Google Films". * @param displayName displayName or {@code null} for none */ public Avail setDisplayName(java.lang.String displayName) { this.displayName = displayName; return this; } /** * Manifestation Identifier. This should be the Manifestation Level EIDR. Example: * "10.2340/1489-49A2-3956-4B2D-FE16-7" * @return value or {@code null} for none */ public java.lang.String getEncodeId() { return encodeId; } /** * Manifestation Identifier. This should be the Manifestation Level EIDR. Example: * "10.2340/1489-49A2-3956-4B2D-FE16-7" * @param encodeId encodeId or {@code null} for none */ public Avail setEncodeId(java.lang.String encodeId) { this.encodeId = encodeId; return this; } /** * End of term in YYYY-MM-DD format in the timezone of the country of the Avail. "Open" if no end * date is available. Example: "2019-02-17" * @return value or {@code null} for none */ public java.lang.String getEnd() { return end; } /** * End of term in YYYY-MM-DD format in the timezone of the country of the Avail. "Open" if no end * date is available. Example: "2019-02-17" * @param end end or {@code null} for none */ public Avail setEnd(java.lang.String end) { this.end = end; return this; } /** * Other identifier referring to the episode, as defined by partner. Only available on TV avails. * Example: "rs_googlers_s1_3". * @return value or {@code null} for none */ public java.lang.String getEpisodeAltId() { return episodeAltId; } /** * Other identifier referring to the episode, as defined by partner. Only available on TV avails. * Example: "rs_googlers_s1_3". * @param episodeAltId episodeAltId or {@code null} for none */ public Avail setEpisodeAltId(java.lang.String episodeAltId) { this.episodeAltId = episodeAltId; return this; } /** * The number assigned to the episode within a season. Only available on TV Avails. Example: "3". * @return value or {@code null} for none */ public java.lang.String getEpisodeNumber() { return episodeNumber; } /** * The number assigned to the episode within a season. Only available on TV Avails. Example: "3". * @param episodeNumber episodeNumber or {@code null} for none */ public Avail setEpisodeNumber(java.lang.String episodeNumber) { this.episodeNumber = episodeNumber; return this; } /** * OPTIONAL.TV Only. Title used by involved parties to refer to this episode. Only available on TV * Avails. Example: "Coding at Google". * @return value or {@code null} for none */ public java.lang.String getEpisodeTitleInternalAlias() { return episodeTitleInternalAlias; } /** * OPTIONAL.TV Only. Title used by involved parties to refer to this episode. Only available on TV * Avails. Example: "Coding at Google". * @param episodeTitleInternalAlias episodeTitleInternalAlias or {@code null} for none */ public Avail setEpisodeTitleInternalAlias(java.lang.String episodeTitleInternalAlias) { this.episodeTitleInternalAlias = episodeTitleInternalAlias; return this; } /** * Indicates the format profile covered by the transaction. * @return value or {@code null} for none */ public java.lang.String getFormatProfile() { return formatProfile; } /** * Indicates the format profile covered by the transaction. * @param formatProfile formatProfile or {@code null} for none */ public Avail setFormatProfile(java.lang.String formatProfile) { this.formatProfile = formatProfile; return this; } /** * Type of transaction. * @return value or {@code null} for none */ public java.lang.String getLicenseType() { return licenseType; } /** * Type of transaction. * @param licenseType licenseType or {@code null} for none */ public Avail setLicenseType(java.lang.String licenseType) { this.licenseType = licenseType; return this; } /** * Name of the post-production houses that manage the Avail. Not part of EMA Specs. * @return value or {@code null} for none */ public java.util.List getPphNames() { return pphNames; } /** * Name of the post-production houses that manage the Avail. Not part of EMA Specs. * @param pphNames pphNames or {@code null} for none */ public Avail setPphNames(java.util.List pphNames) { this.pphNames = pphNames; return this; } /** * Type of pricing that should be applied to this Avail based on how the partner classify them. * Example: "Tier", "WSP", "SRP", or "Category". * @return value or {@code null} for none */ public java.lang.String getPriceType() { return priceType; } /** * Type of pricing that should be applied to this Avail based on how the partner classify them. * Example: "Tier", "WSP", "SRP", or "Category". * @param priceType priceType or {@code null} for none */ public Avail setPriceType(java.lang.String priceType) { this.priceType = priceType; return this; } /** * Value to be applied to the pricing type. Example: "4" or "2.99" * @return value or {@code null} for none */ public java.lang.String getPriceValue() { return priceValue; } /** * Value to be applied to the pricing type. Example: "4" or "2.99" * @param priceValue priceValue or {@code null} for none */ public Avail setPriceValue(java.lang.String priceValue) { this.priceValue = priceValue; return this; } /** * Edit Identifier. This should be the Edit Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D- * FE16-6" * @return value or {@code null} for none */ public java.lang.String getProductId() { return productId; } /** * Edit Identifier. This should be the Edit Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D- * FE16-6" * @param productId productId or {@code null} for none */ public Avail setProductId(java.lang.String productId) { this.productId = productId; return this; } /** * Value representing the rating reason. Rating reasons should be formatted as per [EMA ratings * spec](http://www.movielabs.com/md/ratings/) and comma-separated for inclusion of multiple * reasons. Example: "L, S, V" * @return value or {@code null} for none */ public java.lang.String getRatingReason() { return ratingReason; } /** * Value representing the rating reason. Rating reasons should be formatted as per [EMA ratings * spec](http://www.movielabs.com/md/ratings/) and comma-separated for inclusion of multiple * reasons. Example: "L, S, V" * @param ratingReason ratingReason or {@code null} for none */ public Avail setRatingReason(java.lang.String ratingReason) { this.ratingReason = ratingReason; return this; } /** * Rating system applied to the version of title within territory of Avail. Rating systems should * be formatted as per [EMA ratings spec](http://www.movielabs.com/md/ratings/) Example: "MPAA" * @return value or {@code null} for none */ public java.lang.String getRatingSystem() { return ratingSystem; } /** * Rating system applied to the version of title within territory of Avail. Rating systems should * be formatted as per [EMA ratings spec](http://www.movielabs.com/md/ratings/) Example: "MPAA" * @param ratingSystem ratingSystem or {@code null} for none */ public Avail setRatingSystem(java.lang.String ratingSystem) { this.ratingSystem = ratingSystem; return this; } /** * Value representing the rating. Ratings should be formatted as per * http://www.movielabs.com/md/ratings/ Example: "PG" * @return value or {@code null} for none */ public java.lang.String getRatingValue() { return ratingValue; } /** * Value representing the rating. Ratings should be formatted as per * http://www.movielabs.com/md/ratings/ Example: "PG" * @param ratingValue ratingValue or {@code null} for none */ public Avail setRatingValue(java.lang.String ratingValue) { this.ratingValue = ratingValue; return this; } /** * Release date of the Title in earliest released territory. Typically it is just the year, but it * is free-form as per EMA spec. Examples: "1979", "Oct 2014" * @return value or {@code null} for none */ public java.lang.String getReleaseDate() { return releaseDate; } /** * Release date of the Title in earliest released territory. Typically it is just the year, but it * is free-form as per EMA spec. Examples: "1979", "Oct 2014" * @param releaseDate releaseDate or {@code null} for none */ public Avail setReleaseDate(java.lang.String releaseDate) { this.releaseDate = releaseDate; return this; } /** * Other identifier referring to the season, as defined by partner. Only available on TV avails. * Example: "rs_googlers_s1". * @return value or {@code null} for none */ public java.lang.String getSeasonAltId() { return seasonAltId; } /** * Other identifier referring to the season, as defined by partner. Only available on TV avails. * Example: "rs_googlers_s1". * @param seasonAltId seasonAltId or {@code null} for none */ public Avail setSeasonAltId(java.lang.String seasonAltId) { this.seasonAltId = seasonAltId; return this; } /** * The number assigned to the season within a series. Only available on TV Avails. Example: "1". * @return value or {@code null} for none */ public java.lang.String getSeasonNumber() { return seasonNumber; } /** * The number assigned to the season within a series. Only available on TV Avails. Example: "1". * @param seasonNumber seasonNumber or {@code null} for none */ public Avail setSeasonNumber(java.lang.String seasonNumber) { this.seasonNumber = seasonNumber; return this; } /** * Title used by involved parties to refer to this season. Only available on TV Avails. Example: * "Googlers, The". * @return value or {@code null} for none */ public java.lang.String getSeasonTitleInternalAlias() { return seasonTitleInternalAlias; } /** * Title used by involved parties to refer to this season. Only available on TV Avails. Example: * "Googlers, The". * @param seasonTitleInternalAlias seasonTitleInternalAlias or {@code null} for none */ public Avail setSeasonTitleInternalAlias(java.lang.String seasonTitleInternalAlias) { this.seasonTitleInternalAlias = seasonTitleInternalAlias; return this; } /** * Other identifier referring to the series, as defined by partner. Only available on TV avails. * Example: "rs_googlers". * @return value or {@code null} for none */ public java.lang.String getSeriesAltId() { return seriesAltId; } /** * Other identifier referring to the series, as defined by partner. Only available on TV avails. * Example: "rs_googlers". * @param seriesAltId seriesAltId or {@code null} for none */ public Avail setSeriesAltId(java.lang.String seriesAltId) { this.seriesAltId = seriesAltId; return this; } /** * Title used by involved parties to refer to this series. Only available on TV Avails. Example: * "Googlers, The". * @return value or {@code null} for none */ public java.lang.String getSeriesTitleInternalAlias() { return seriesTitleInternalAlias; } /** * Title used by involved parties to refer to this series. Only available on TV Avails. Example: * "Googlers, The". * @param seriesTitleInternalAlias seriesTitleInternalAlias or {@code null} for none */ public Avail setSeriesTitleInternalAlias(java.lang.String seriesTitleInternalAlias) { this.seriesTitleInternalAlias = seriesTitleInternalAlias; return this; } /** * Start of term in YYYY-MM-DD format in the timezone of the country of the Avail. Example: * "2013-05-14". * @return value or {@code null} for none */ public java.lang.String getStart() { return start; } /** * Start of term in YYYY-MM-DD format in the timezone of the country of the Avail. Example: * "2013-05-14". * @param start start or {@code null} for none */ public Avail setStart(java.lang.String start) { this.start = start; return this; } /** * Spoken language of the intended audience. Language shall be encoded in accordance with RFC * 5646. Example: "fr". * @return value or {@code null} for none */ public java.lang.String getStoreLanguage() { return storeLanguage; } /** * Spoken language of the intended audience. Language shall be encoded in accordance with RFC * 5646. Example: "fr". * @param storeLanguage storeLanguage or {@code null} for none */ public Avail setStoreLanguage(java.lang.String storeLanguage) { this.storeLanguage = storeLanguage; return this; } /** * First date an Edit could be publically announced as becoming available at a specific future * date in territory of Avail. *Not* the Avail start date or pre-order start date. Format is YYYY- * MM-DD. Only available for pre-orders. Example: "2012-12-10" * @return value or {@code null} for none */ public java.lang.String getSuppressionLiftDate() { return suppressionLiftDate; } /** * First date an Edit could be publically announced as becoming available at a specific future * date in territory of Avail. *Not* the Avail start date or pre-order start date. Format is YYYY- * MM-DD. Only available for pre-orders. Example: "2012-12-10" * @param suppressionLiftDate suppressionLiftDate or {@code null} for none */ public Avail setSuppressionLiftDate(java.lang.String suppressionLiftDate) { this.suppressionLiftDate = suppressionLiftDate; return this; } /** * ISO 3166-1 alpha-2 country code for the country or territory of this Avail. For Avails, we use * Territory in lieu of Country to comply with EMA specifications. But please note that Territory * and Country identify the same thing. Example: "US". * @return value or {@code null} for none */ public java.lang.String getTerritory() { return territory; } /** * ISO 3166-1 alpha-2 country code for the country or territory of this Avail. For Avails, we use * Territory in lieu of Country to comply with EMA specifications. But please note that Territory * and Country identify the same thing. Example: "US". * @param territory territory or {@code null} for none */ public Avail setTerritory(java.lang.String territory) { this.territory = territory; return this; } /** * Title used by involved parties to refer to this content. Example: "Googlers, The". Only * available on Movie Avails. * @return value or {@code null} for none */ public java.lang.String getTitleInternalAlias() { return titleInternalAlias; } /** * Title used by involved parties to refer to this content. Example: "Googlers, The". Only * available on Movie Avails. * @param titleInternalAlias titleInternalAlias or {@code null} for none */ public Avail setTitleInternalAlias(java.lang.String titleInternalAlias) { this.titleInternalAlias = titleInternalAlias; return this; } /** * Google-generated ID identifying the video linked to this Avail, once delivered. Not part of EMA * Specs. Example: 'gtry456_xc' * @return value or {@code null} for none */ public java.lang.String getVideoId() { return videoId; } /** * Google-generated ID identifying the video linked to this Avail, once delivered. Not part of EMA * Specs. Example: 'gtry456_xc' * @param videoId videoId or {@code null} for none */ public Avail setVideoId(java.lang.String videoId) { this.videoId = videoId; return this; } /** * Work type as enumerated in EMA. * @return value or {@code null} for none */ public java.lang.String getWorkType() { return workType; } /** * Work type as enumerated in EMA. * @param workType workType or {@code null} for none */ public Avail setWorkType(java.lang.String workType) { this.workType = workType; return this; } @Override public Avail set(String fieldName, Object value) { return (Avail) super.set(fieldName, value); } @Override public Avail clone() { return (Avail) super.clone(); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy