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

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-youtube Show documentation

There is a newer version: v3-rev20240514-2.0.0

Show newest version







SearchResult (YouTube Data API v3 v3-rev20240417-2.0.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 SearchResult



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.SearchResult













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




public final class SearchResult
extends com.google.api.client.json.GenericJson
A search result contains information about a YouTube video, channel, or playlist that matches the
 search parameters specified in an API request. While a search result points to a uniquely
 identifiable resource, like a video, it does not have its own persistent data.

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


SearchResult() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


SearchResult
clone() 


String
getEtag()
Etag of this resource.



ResourceId
getId()
The id object contains information that can be used to uniquely identify the resource that
 matches the search request.



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



SearchResultSnippet
getSnippet()
The snippet object contains basic details about a search result, such as its title or
 description.



SearchResult
set(String fieldName,
   Object value) 


SearchResult
setEtag(String etag)
Etag of this resource.



SearchResult
setId(ResourceId id)
The id object contains information that can be used to uniquely identify the resource that
 matches the search request.



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



SearchResult
setSnippet(SearchResultSnippet snippet)
The snippet object contains basic details about a search result, such as its title or
 description.







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





SearchResult
public SearchResult()









Method Detail





getEtag
public String getEtag()
Etag of this resource.

Returns:
value or null for none








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

Parameters:
etag - etag or null for none








getId
public ResourceId getId()
The id object contains information that can be used to uniquely identify the resource that
 matches the search request.

Returns:
value or null for none








setId
public SearchResult setId(ResourceId id)
The id object contains information that can be used to uniquely identify the resource that
 matches the search request.

Parameters:
id - id or null for none








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

Returns:
value or null for none








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

Parameters:
kind - kind or null for none








getSnippet
public SearchResultSnippet getSnippet()
The snippet object contains basic details about a search result, such as its title or
 description. For example, if the search result is a video, then the title will be the video's
 title and the description will be the video's description.

Returns:
value or null for none








setSnippet
public SearchResult setSnippet(SearchResultSnippet snippet)
The snippet object contains basic details about a search result, such as its title or
 description. For example, if the search result is a video, then the title will be the video's
 title and the description will be the video's description.

Parameters:
snippet - snippet or null for none








set
public SearchResult set(String fieldName,
                        Object value)

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








clone
public SearchResult clone()

Overrides:
clone in class com.google.api.client.json.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–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`SearchResult`	`clone()`
`String`	`getEtag()` Etag of this resource.
`ResourceId`	`getId()` The id object contains information that can be used to uniquely identify the resource that matches the search request.
`String`	`getKind()` Identifies what kind of resource this is.
`SearchResultSnippet`	`getSnippet()` The snippet object contains basic details about a search result, such as its title or description.
`SearchResult`	`set(String fieldName, Object value)`
`SearchResult`	`setEtag(String etag)` Etag of this resource.
`SearchResult`	`setId(ResourceId id)` The id object contains information that can be used to uniquely identify the resource that matches the search request.
`SearchResult`	`setKind(String kind)` Identifies what kind of resource this is.
`SearchResult`	`setSnippet(SearchResultSnippet snippet)` The snippet object contains basic details about a search result, such as its title or description.