com.google.api.services.docs.v1.model

Class ReplaceImageRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.docs.v1.model.ReplaceImageRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ReplaceImageRequest
extends com.google.api.client.json.GenericJson

Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image in order to mirror the behavior of the Docs editor.

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 Docs API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ReplaceImageRequest()

Method Summary

Modifier and Type	Method and Description
ReplaceImageRequest	clone()
String	getImageObjectId() The ID of the existing image that will be replaced.
String	getImageReplaceMethod() The replacement method.
String	getTabId() The tab that the image to be replaced is in.
String	getUri() The URI of the new image.
ReplaceImageRequest	set(String fieldName, Object value)
ReplaceImageRequest	setImageObjectId(String imageObjectId) The ID of the existing image that will be replaced.
ReplaceImageRequest	setImageReplaceMethod(String imageReplaceMethod) The replacement method.
ReplaceImageRequest	setTabId(String tabId) The tab that the image to be replaced is in.
ReplaceImageRequest	setUri(String uri) The URI of the new image.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ReplaceImageRequest

public ReplaceImageRequest()

Method Detail

getImageObjectId

public String getImageObjectId()

The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request.

Returns:

value or null for none

setImageObjectId

public ReplaceImageRequest setImageObjectId(String imageObjectId)

The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request.

Parameters:

imageObjectId - imageObjectId or null for none

getImageReplaceMethod

public String getImageReplaceMethod()

The replacement method.

Returns:

value or null for none

setImageReplaceMethod

public ReplaceImageRequest setImageReplaceMethod(String imageReplaceMethod)

The replacement method.

Parameters:

imageReplaceMethod - imageReplaceMethod or null for none

getTabId

public String getTabId()

The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.

Returns:

value or null for none

setTabId

public ReplaceImageRequest setTabId(String tabId)

The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.

Parameters:

tabId - tabId or null for none

getUri

public String getUri()

The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field.

Returns:

value or null for none

setUri

public ReplaceImageRequest setUri(String uri)

The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field.

Parameters:

uri - uri or null for none

set

public ReplaceImageRequest set(String fieldName,
                               Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ReplaceImageRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson