com.google.api.services.youtube.model.InvideoBranding Maven / Gradle / Ivy
/*
* 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://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.youtube.model;
/**
* LINT.IfChange Describes an invideo branding.
*
* 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 YouTube Data API v3. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class InvideoBranding extends com.google.api.client.json.GenericJson {
/**
* The bytes the uploaded image. Only used in api to youtube communication.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String imageBytes;
/**
* The url of the uploaded image. Only used in apiary to api communication.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String imageUrl;
/**
* The spatial position within the video where the branding watermark will be displayed.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private InvideoPosition position;
/**
* The channel to which this branding links. If not present it defaults to the current channel.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String targetChannelId;
/**
* The temporal position within the video where watermark will be displayed.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private InvideoTiming timing;
/**
* The bytes the uploaded image. Only used in api to youtube communication.
* @see #decodeImageBytes()
* @return value or {@code null} for none
*/
public java.lang.String getImageBytes() {
return imageBytes;
}
/**
* The bytes the uploaded image. Only used in api to youtube communication.
* @see #getImageBytes()
* @return Base64 decoded value or {@code null} for none
*
* @since 1.14
*/
public byte[] decodeImageBytes() {
return com.google.api.client.util.Base64.decodeBase64(imageBytes);
}
/**
* The bytes the uploaded image. Only used in api to youtube communication.
* @see #encodeImageBytes()
* @param imageBytes imageBytes or {@code null} for none
*/
public InvideoBranding setImageBytes(java.lang.String imageBytes) {
this.imageBytes = imageBytes;
return this;
}
/**
* The bytes the uploaded image. Only used in api to youtube communication.
* @see #setImageBytes()
*
*
* The value is encoded Base64 or {@code null} for none.
*
*
* @since 1.14
*/
public InvideoBranding encodeImageBytes(byte[] imageBytes) {
this.imageBytes = com.google.api.client.util.Base64.encodeBase64URLSafeString(imageBytes);
return this;
}
/**
* The url of the uploaded image. Only used in apiary to api communication.
* @return value or {@code null} for none
*/
public java.lang.String getImageUrl() {
return imageUrl;
}
/**
* The url of the uploaded image. Only used in apiary to api communication.
* @param imageUrl imageUrl or {@code null} for none
*/
public InvideoBranding setImageUrl(java.lang.String imageUrl) {
this.imageUrl = imageUrl;
return this;
}
/**
* The spatial position within the video where the branding watermark will be displayed.
* @return value or {@code null} for none
*/
public InvideoPosition getPosition() {
return position;
}
/**
* The spatial position within the video where the branding watermark will be displayed.
* @param position position or {@code null} for none
*/
public InvideoBranding setPosition(InvideoPosition position) {
this.position = position;
return this;
}
/**
* The channel to which this branding links. If not present it defaults to the current channel.
* @return value or {@code null} for none
*/
public java.lang.String getTargetChannelId() {
return targetChannelId;
}
/**
* The channel to which this branding links. If not present it defaults to the current channel.
* @param targetChannelId targetChannelId or {@code null} for none
*/
public InvideoBranding setTargetChannelId(java.lang.String targetChannelId) {
this.targetChannelId = targetChannelId;
return this;
}
/**
* The temporal position within the video where watermark will be displayed.
* @return value or {@code null} for none
*/
public InvideoTiming getTiming() {
return timing;
}
/**
* The temporal position within the video where watermark will be displayed.
* @param timing timing or {@code null} for none
*/
public InvideoBranding setTiming(InvideoTiming timing) {
this.timing = timing;
return this;
}
@Override
public InvideoBranding set(String fieldName, Object value) {
return (InvideoBranding) super.set(fieldName, value);
}
@Override
public InvideoBranding clone() {
return (InvideoBranding) super.clone();
}
}