com.google.api.services.directory.model

Class UserPhoto

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.directory.model.UserPhoto

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class UserPhoto
extends GenericJson

Model definition for UserPhoto.

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 Admin SDK 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

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
UserPhoto()

Method Summary

Modifier and Type	Method and Description
UserPhoto	clone()
byte[]	decodePhotoData() The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes.
UserPhoto	encodePhotoData(byte[] photoData) The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes.
String	getEtag() ETag of the resource.
Integer	getHeight() Height of the photo in pixels.
String	getId() The ID the API uses to uniquely identify the user.
String	getKind() The type of the API resource.
String	getMimeType() The MIME type of the photo.
String	getPhotoData() The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes.
String	getPrimaryEmail() The user's primary email address.
Integer	getWidth() Width of the photo in pixels.
UserPhoto	set(String fieldName, Object value)
UserPhoto	setEtag(String etag) ETag of the resource.
UserPhoto	setHeight(Integer height) Height of the photo in pixels.
UserPhoto	setId(String id) The ID the API uses to uniquely identify the user.
UserPhoto	setKind(String kind) The type of the API resource.
UserPhoto	setMimeType(String mimeType) The MIME type of the photo.
UserPhoto	setPhotoData(String photoData) The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes.
UserPhoto	setPrimaryEmail(String primaryEmail) The user's primary email address.
UserPhoto	setWidth(Integer width) Width of the photo in pixels.

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

UserPhoto

public UserPhoto()

Method Detail

getEtag

public String getEtag()

ETag of the resource.

Returns:

value or null for none

setEtag

public UserPhoto setEtag(String etag)

ETag of the resource.

Parameters:

etag - etag or null for none

getHeight

public Integer getHeight()

Height of the photo in pixels.

Returns:

value or null for none

setHeight

public UserPhoto setHeight(Integer height)

Height of the photo in pixels.

Parameters:

height - height or null for none

getId

public String getId()

The ID the API uses to uniquely identify the user.

Returns:

value or null for none

setId

public UserPhoto setId(String id)

The ID the API uses to uniquely identify the user.

Parameters:

id - id or null for none

getKind

public String getKind()

The type of the API resource. For Photo resources, this is `admin#directory#user#photo`.

Returns:

value or null for none

setKind

public UserPhoto setKind(String kind)

The type of the API resource. For Photo resources, this is `admin#directory#user#photo`.

Parameters:

kind - kind or null for none

getMimeType

public String getMimeType()

The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web- safe base64 encoding.

Returns:

value or null for none

setMimeType

public UserPhoto setMimeType(String mimeType)

The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web- safe base64 encoding.

Parameters:

mimeType - mimeType or null for none

getPhotoData

public String getPhotoData()

The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels.

Returns:

value or null for none

See Also:

decodePhotoData()

decodePhotoData

public byte[] decodePhotoData()

The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getPhotoData()

setPhotoData

public UserPhoto setPhotoData(String photoData)

The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels.

Parameters:

photoData - photoData or null for none

See Also:

#encodePhotoData()

encodePhotoData

public UserPhoto encodePhotoData(byte[] photoData)

The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getPrimaryEmail

public String getPrimaryEmail()

The user's primary email address.

Returns:

value or null for none

setPrimaryEmail

public UserPhoto setPrimaryEmail(String primaryEmail)

The user's primary email address.

Parameters:

primaryEmail - primaryEmail or null for none

getWidth

public Integer getWidth()

Width of the photo in pixels.

Returns:

value or null for none

setWidth

public UserPhoto setWidth(Integer width)

Width of the photo in pixels.

Parameters:

width - width or null for none

set

public UserPhoto set(String fieldName,
                     Object value)

Overrides:

set in class GenericJson

clone

public UserPhoto clone()

Overrides:

clone in class GenericJson