target.apidocs.com.google.api.services.youtube.model.SearchListResponse.html Maven / Gradle / Ivy







SearchListResponse (YouTube Data API v3 v3-rev20210410-1.31.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.youtube.model
Class SearchListResponse



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.youtube.model.SearchListResponse













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class SearchListResponse
extends GenericJson
Model definition for SearchListResponse.

  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.












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


SearchListResponse() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


SearchListResponse
clone() 


String
getEtag()
Etag of this resource.



String
getEventId()
Serialized EventId of the request which produced this response.



List<SearchResult>
getItems()
Pagination information for token pagination.



String
getKind()
Identifies what kind of resource this is.



String
getNextPageToken()
The token that can be used as the value of the pageToken parameter to retrieve the next page in
 the result set.



PageInfo
getPageInfo()
General pagination information.



String
getPrevPageToken()
The token that can be used as the value of the pageToken parameter to retrieve the previous
 page in the result set.



String
getRegionCode() 


TokenPagination
getTokenPagination() 


String
getVisitorId()
The visitorId identifies the visitor.



SearchListResponse
set(String fieldName,
   Object value) 


SearchListResponse
setEtag(String etag)
Etag of this resource.



SearchListResponse
setEventId(String eventId)
Serialized EventId of the request which produced this response.



SearchListResponse
setItems(List<SearchResult> items)
Pagination information for token pagination.



SearchListResponse
setKind(String kind)
Identifies what kind of resource this is.



SearchListResponse
setNextPageToken(String nextPageToken)
The token that can be used as the value of the pageToken parameter to retrieve the next page in
 the result set.



SearchListResponse
setPageInfo(PageInfo pageInfo)
General pagination information.



SearchListResponse
setPrevPageToken(String prevPageToken)
The token that can be used as the value of the pageToken parameter to retrieve the previous
 page in the result set.



SearchListResponse
setRegionCode(String regionCode) 


SearchListResponse
setTokenPagination(TokenPagination tokenPagination) 


SearchListResponse
setVisitorId(String visitorId)
The visitorId identifies the visitor.







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





SearchListResponse
public SearchListResponse()









Method Detail





getEtag
public String getEtag()
Etag of this resource.

Returns:
value or null for none








setEtag
public SearchListResponse setEtag(String etag)
Etag of this resource.

Parameters:
etag - etag or null for none








getEventId
public String getEventId()
Serialized EventId of the request which produced this response.

Returns:
value or null for none








setEventId
public SearchListResponse setEventId(String eventId)
Serialized EventId of the request which produced this response.

Parameters:
eventId - eventId or null for none








getItems
public List<SearchResult> getItems()
Pagination information for token pagination.

Returns:
value or null for none








setItems
public SearchListResponse setItems(List<SearchResult> items)
Pagination information for token pagination.

Parameters:
items - items or null for none








getKind
public String getKind()
Identifies what kind of resource this is. Value: the fixed string "youtube#searchListResponse".

Returns:
value or null for none








setKind
public SearchListResponse setKind(String kind)
Identifies what kind of resource this is. Value: the fixed string "youtube#searchListResponse".

Parameters:
kind - kind or null for none








getNextPageToken
public String getNextPageToken()
The token that can be used as the value of the pageToken parameter to retrieve the next page in
 the result set.

Returns:
value or null for none








setNextPageToken
public SearchListResponse setNextPageToken(String nextPageToken)
The token that can be used as the value of the pageToken parameter to retrieve the next page in
 the result set.

Parameters:
nextPageToken - nextPageToken or null for none








getPageInfo
public PageInfo getPageInfo()
General pagination information.

Returns:
value or null for none








setPageInfo
public SearchListResponse setPageInfo(PageInfo pageInfo)
General pagination information.

Parameters:
pageInfo - pageInfo or null for none








getPrevPageToken
public String getPrevPageToken()
The token that can be used as the value of the pageToken parameter to retrieve the previous
 page in the result set.

Returns:
value or null for none








setPrevPageToken
public SearchListResponse setPrevPageToken(String prevPageToken)
The token that can be used as the value of the pageToken parameter to retrieve the previous
 page in the result set.

Parameters:
prevPageToken - prevPageToken or null for none








getRegionCode
public String getRegionCode()

Returns:
value or null for none








setRegionCode
public SearchListResponse setRegionCode(String regionCode)

Parameters:
regionCode - regionCode or null for none








getTokenPagination
public TokenPagination getTokenPagination()

Returns:
value or null for none








setTokenPagination
public SearchListResponse setTokenPagination(TokenPagination tokenPagination)

Parameters:
tokenPagination - tokenPagination or null for none








getVisitorId
public String getVisitorId()
The visitorId identifies the visitor.

Returns:
value or null for none








setVisitorId
public SearchListResponse setVisitorId(String visitorId)
The visitorId identifies the visitor.

Parameters:
visitorId - visitorId or null for none








set
public SearchListResponse set(String fieldName,
                              Object value)

Overrides:
set in class GenericJson








clone
public SearchListResponse clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2021 Google. All rights reserved.

Modifier and Type	Method and Description
`SearchListResponse`	`clone()`
`String`	`getEtag()` Etag of this resource.
`String`	`getEventId()` Serialized EventId of the request which produced this response.
`List<SearchResult>`	`getItems()` Pagination information for token pagination.
`String`	`getKind()` Identifies what kind of resource this is.
`String`	`getNextPageToken()` The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
`PageInfo`	`getPageInfo()` General pagination information.
`String`	`getPrevPageToken()` The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
`String`	`getRegionCode()`
`TokenPagination`	`getTokenPagination()`
`String`	`getVisitorId()` The visitorId identifies the visitor.
`SearchListResponse`	`set(String fieldName, Object value)`
`SearchListResponse`	`setEtag(String etag)` Etag of this resource.
`SearchListResponse`	`setEventId(String eventId)` Serialized EventId of the request which produced this response.
`SearchListResponse`	`setItems(List<SearchResult> items)` Pagination information for token pagination.
`SearchListResponse`	`setKind(String kind)` Identifies what kind of resource this is.
`SearchListResponse`	`setNextPageToken(String nextPageToken)` The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
`SearchListResponse`	`setPageInfo(PageInfo pageInfo)` General pagination information.
`SearchListResponse`	`setPrevPageToken(String prevPageToken)` The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
`SearchListResponse`	`setRegionCode(String regionCode)`
`SearchListResponse`	`setTokenPagination(TokenPagination tokenPagination)`
`SearchListResponse`	`setVisitorId(String visitorId)` The visitorId identifies the visitor.