Package animeshon.image.v1alpha1

Index

• Image
• ImageRouter
• Album
• AlbumSettings
• CreateAlbumRequest
• DeleteAlbumRequest
• GetAlbumRequest
• GetAlbumSettingsRequest
• GetImageRequest
• GetImageRequest.ResizeBounds
• GetImageRouteRequest
• GetImageRouteResponse
• ImportImageRequest
• ImportImageRequest.WebCacheOptions
• ImportImageResponse
• ImportImageResponse.ImportImageRemoteError
• ImportImageResponse.ImportImageResult
• ListAlbumsRequest
• ListAlbumsResponse
• RouteImageRequest
• UpdateAlbumSettingsRequest
• UploadImageRequest
• UploadImageResponse

Image

UploadImage
rpc UploadImage(UploadImageRequest) UploadImageResponse Uploads an image through the request HttpBody.

ImportImage
rpc ImportImage(ImportImageRequest) ImportImageResponse Imports an image from a remote web address.

GetImage
rpc GetImage(GetImageRequest) .google.api.HttpBody Gets an image in binary representation with the format and size requested.

GetAlbum
rpc GetAlbum(GetAlbumRequest) Album Gets an image album.

ListAlbums
rpc ListAlbums(ListAlbumsRequest) ListAlbumsResponse Lists image albums with pagination.

CreateAlbum
rpc CreateAlbum(CreateAlbumRequest) Album Creates a new image album.

DeleteAlbum
rpc DeleteAlbum(DeleteAlbumRequest) .google.protobuf.Empty Deletes an existing image album.

GetAlbumSettings
rpc GetAlbumSettings(GetAlbumSettingsRequest) AlbumSettings Gets the settings of an image album.

UpdateAlbumSettings
rpc UpdateAlbumSettings(UpdateAlbumSettingsRequest) AlbumSettings Updates the settings of an image album.

ImageRouter

The image router is used to generate public links that can be routed through the Animeshon CDN (Content Delivery Network) to guarantee high performance and availability worldwide.

GetImageRoute
rpc GetImageRoute(GetImageRouteRequest) GetImageRouteResponse Gets the image public link address that is used to fetch images via CDN.

RouteImage
rpc RouteImage(RouteImageRequest) .google.api.HttpBody Routes a raw request received by a CDN host to its target image.

Album

Field	Description
name	string The album resource name.
display_name	string The album display name.

AlbumSettings

Field	Description
name	string The album resource name.
bucket	string The bucket where to store resources.
system_managed	bool Whether the album is system managed.
enable_search	bool Whether images in this album show up in the search engine results.
enable_annotation	bool Whether images in this album can be annotated.
enable_encryption	bool Whether images in this album must be client-side encrypted.
high_visibility	bool Whether the content of this album is highly visible by the public such as profile pictures and banners. Highly visible albums cannot contain sensitive or adult images.

CreateAlbumRequest

Field	Description
parent	string The parent this album belongs to.
album	Album The album to create.

DeleteAlbumRequest

Field	Description
name	string The album to delete.

GetAlbumRequest

Field	Description
name	string The name of the album to retrieve.

GetAlbumSettingsRequest

Field	Description
name	string The name of the album to retrieve settings from.

GetImageRequest

Field	Description
name	string The image resource name.
content_type	string If content type is set and differs from the original content type the image will be converted to match the specified content type.

Note: only "image/png", "image/webp", "image/jpeg" are supported values. | | resize | GetImageRequest.ResizeBounds
The image bounding box to use for resizing. This value is normally used to request image thumbnails. If both width and height are defined then the value with smaller ratio will be used to resize the image. The resized image has the closest standard ratio to the requested width or height. If the requested ratio is larger than the original image it is ignored. | | blur | bool
Whether the image returned should be blurred. This is typically used while routing images that have been detected to contain highly sensitive or controversial content that must be censored in some or all regions. |

GetImageRequest.ResizeBounds

The image resize bounds.

Field	Description
width	int32 The image width.
height	int32 The image height.

GetImageRouteRequest

Field	Description
name	string

GetImageRouteResponse

Field	Description
url	string A routable url that points to a link address backed by the CDN.

ImportImageRequest

Field	Description
parent	string The image parent of the image. This value defaults to the user performing the import operation if no parent is set.
uri	string A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Animeshon cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DoS prevention), or if Animeshon throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications.
cache_options	ImportImageRequest.WebCacheOptions The web cache options to apply to the import request.

ImportImageRequest.WebCacheOptions

The WebCache options to be used when importing an image from a public website address.

Field	Description
refresh	bool If refresh is set to true the image is imported from the remote address regardless of an existing local cache, if the fetched image does not match the existing cache the new image is stored and a new resource is created, otherwise the existing (cached) resource is returned.
ignore	bool If ignore is set to true no cache lookup is performed and the image is imported into a new resource. If both "ignore" and "refresh" are set to true then "refresh" has no effect.

ImportImageResponse

Field	Description
oneof response result	ImportImageResponse.ImportImageResult If the import was successful this field will provide the newly created image resource name.
oneof response error	ImportImageResponse.ImportImageRemoteError If the import ended up in a failure due to an error with the remote server this field will provide more details about the failure.
cache_hit	bool Whether this image was found in the cache.

ImportImageResponse.ImportImageRemoteError

Field	Description
status_code	int32 The status code returned from the remote server.
details	string The details related to the import failure.

ImportImageResponse.ImportImageResult

Field	Description
name	string The image resource name.

ListAlbumsRequest

Field	Description
parent	string The parent, which owns this collection of albums.
page_size	int32 If unspecified, server will pick an appropriate default.
page_token	string The value returned from the previous call.
filter	string A filter to be applied to results.

ListAlbumsResponse

Field	Description
albums	repeated Album The list of albums.
next_page_token	string A token to retrieve next page of results.

RouteImageRequest

Field	Description
host	string The host that received the request.
path	string The requested path representing an opaque route.

UpdateAlbumSettingsRequest

Field	Description
settings	AlbumSettings The album settings to update.
update_mask	google.protobuf.FieldMask The field mask to determine which fields are to be updated. If empty, the server will assume all fields are to be updated.

UploadImageRequest

Field	Description
parent	string The image parent of the image. This value defaults to the user performing the upload operation if no parent is set.
body	google.api.HttpBody The image content, represented as an HttpBody.

UploadImageResponse

Field	Description
name	string The image resource name.