Class SearchMediaItemsRequest
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.photos.library.v1.proto.SearchMediaItemsRequest
-
- All Implemented Interfaces:
SearchMediaItemsRequestOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.io.Serializable
public final class SearchMediaItemsRequest extends com.google.protobuf.GeneratedMessageV3 implements SearchMediaItemsRequestOrBuilder
Request to search for media items in a user's library. If the album id is specified, this call will return the list of media items in the album. If neither filters nor album id are specified, this call will return all media items in a user's Google Photos library. If filters are specified, this call will return all media items in the user's library that fulfill the filter criteria. Filters and album id must not both be set, as this will result in an invalid request.
Protobuf typegoogle.photos.library.v1.SearchMediaItemsRequest
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SearchMediaItemsRequest.Builder
Request to search for media items in a user's library.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
ALBUM_ID_FIELD_NUMBER
static int
FILTERS_FIELD_NUMBER
static int
PAGE_SIZE_FIELD_NUMBER
static int
PAGE_TOKEN_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getAlbumId()
Identifier of an album.com.google.protobuf.ByteString
getAlbumIdBytes()
Identifier of an album.static SearchMediaItemsRequest
getDefaultInstance()
SearchMediaItemsRequest
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
Filters
getFilters()
Filters to apply to the request.FiltersOrBuilder
getFiltersOrBuilder()
Filters to apply to the request.int
getPageSize()
Maximum number of media items to return in the response.java.lang.String
getPageToken()
A continuation token to get the next page of the results.com.google.protobuf.ByteString
getPageTokenBytes()
A continuation token to get the next page of the results.com.google.protobuf.Parser<SearchMediaItemsRequest>
getParserForType()
int
getSerializedSize()
com.google.protobuf.UnknownFieldSet
getUnknownFields()
boolean
hasFilters()
Filters to apply to the request.int
hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static SearchMediaItemsRequest.Builder
newBuilder()
static SearchMediaItemsRequest.Builder
newBuilder(SearchMediaItemsRequest prototype)
SearchMediaItemsRequest.Builder
newBuilderForType()
protected SearchMediaItemsRequest.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static SearchMediaItemsRequest
parseDelimitedFrom(java.io.InputStream input)
static SearchMediaItemsRequest
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchMediaItemsRequest
parseFrom(byte[] data)
static SearchMediaItemsRequest
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchMediaItemsRequest
parseFrom(com.google.protobuf.ByteString data)
static SearchMediaItemsRequest
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchMediaItemsRequest
parseFrom(com.google.protobuf.CodedInputStream input)
static SearchMediaItemsRequest
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchMediaItemsRequest
parseFrom(java.io.InputStream input)
static SearchMediaItemsRequest
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchMediaItemsRequest
parseFrom(java.nio.ByteBuffer data)
static SearchMediaItemsRequest
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchMediaItemsRequest>
parser()
SearchMediaItemsRequest.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
ALBUM_ID_FIELD_NUMBER
public static final int ALBUM_ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FILTERS_FIELD_NUMBER
public static final int FILTERS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFields
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getUnknownFields
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getAlbumId
public java.lang.String getAlbumId()
Identifier of an album. If populated, lists all media items in specified album. Can't set in conjunction with any filters.
string album_id = 1;
- Specified by:
getAlbumId
in interfaceSearchMediaItemsRequestOrBuilder
-
getAlbumIdBytes
public com.google.protobuf.ByteString getAlbumIdBytes()
Identifier of an album. If populated, lists all media items in specified album. Can't set in conjunction with any filters.
string album_id = 1;
- Specified by:
getAlbumIdBytes
in interfaceSearchMediaItemsRequestOrBuilder
-
getPageSize
public int getPageSize()
Maximum number of media items to return in the response. Fewer media items might be returned than the specified number. The default `pageSize` is 25, the maximum is 100.
int32 page_size = 2;
- Specified by:
getPageSize
in interfaceSearchMediaItemsRequestOrBuilder
-
getPageToken
public java.lang.String getPageToken()
A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `searchMediaItems` request.
string page_token = 3;
- Specified by:
getPageToken
in interfaceSearchMediaItemsRequestOrBuilder
-
getPageTokenBytes
public com.google.protobuf.ByteString getPageTokenBytes()
A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `searchMediaItems` request.
string page_token = 3;
- Specified by:
getPageTokenBytes
in interfaceSearchMediaItemsRequestOrBuilder
-
hasFilters
public boolean hasFilters()
Filters to apply to the request. Can't be set in conjunction with an `albumId`.
.google.photos.library.v1.Filters filters = 4;
- Specified by:
hasFilters
in interfaceSearchMediaItemsRequestOrBuilder
-
getFilters
public Filters getFilters()
Filters to apply to the request. Can't be set in conjunction with an `albumId`.
.google.photos.library.v1.Filters filters = 4;
- Specified by:
getFilters
in interfaceSearchMediaItemsRequestOrBuilder
-
getFiltersOrBuilder
public FiltersOrBuilder getFiltersOrBuilder()
Filters to apply to the request. Can't be set in conjunction with an `albumId`.
.google.photos.library.v1.Filters filters = 4;
- Specified by:
getFiltersOrBuilder
in interfaceSearchMediaItemsRequestOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static SearchMediaItemsRequest parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchMediaItemsRequest parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchMediaItemsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchMediaItemsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchMediaItemsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchMediaItemsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchMediaItemsRequest parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static SearchMediaItemsRequest parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static SearchMediaItemsRequest parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static SearchMediaItemsRequest parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static SearchMediaItemsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static SearchMediaItemsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public SearchMediaItemsRequest.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static SearchMediaItemsRequest.Builder newBuilder()
-
newBuilder
public static SearchMediaItemsRequest.Builder newBuilder(SearchMediaItemsRequest prototype)
-
toBuilder
public SearchMediaItemsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected SearchMediaItemsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static SearchMediaItemsRequest getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<SearchMediaItemsRequest> parser()
-
getParserForType
public com.google.protobuf.Parser<SearchMediaItemsRequest> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public SearchMediaItemsRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-