com.google.api.services.cloudsearch.v1

Class CloudSearch

java.lang.Object

com.google.api.client.googleapis.services.AbstractGoogleClient

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient

com.google.api.services.cloudsearch.v1.CloudSearch

public class CloudSearch
extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient

Service definition for CloudSearch (v1).

Cloud Search provides cloud-based search capabilities over G Suite data. The Cloud Search API allows indexing of non-G Suite data into Cloud Search.

For more information about this service, see the API Documentation

This service uses CloudSearchRequestInitializer to initialize global parameters via its CloudSearch.Builder.

Since:

1.3

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudSearch.Builder Builder for CloudSearch.
class	CloudSearch.Debug The "debug" collection of methods.
class	CloudSearch.Indexing The "indexing" collection of methods.
class	CloudSearch.Media The "media" collection of methods.
class	CloudSearch.Operations The "operations" collection of methods.
class	CloudSearch.Query The "query" collection of methods.
class	CloudSearch.Settings The "settings" collection of methods.
class	CloudSearch.Stats The "stats" collection of methods.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_BASE_URL The default encoded base URL of the service.
static java.lang.String	DEFAULT_BATCH_PATH The default encoded batch path of the service.
static java.lang.String	DEFAULT_ROOT_URL The default encoded root URL of the service.
static java.lang.String	DEFAULT_SERVICE_PATH The default encoded service path of the service.

Constructor Summary

Constructors

Constructor and Description
CloudSearch(com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory, com.google.api.client.http.HttpRequestInitializer httpRequestInitializer) Constructor.

Method Summary

Modifier and Type	Method and Description
CloudSearch.Debug	debug() An accessor for creating requests from the Debug collection.
CloudSearch.Indexing	indexing() An accessor for creating requests from the Indexing collection.
protected void	initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest<?> httpClientRequest)
CloudSearch.Media	media() An accessor for creating requests from the Media collection.
CloudSearch.Operations	operations() An accessor for creating requests from the Operations collection.
CloudSearch.Query	query() An accessor for creating requests from the Query collection.
CloudSearch.Settings	settings() An accessor for creating requests from the Settings collection.
CloudSearch.Stats	stats() An accessor for creating requests from the Stats collection.

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient

getJsonFactory, getObjectParser

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClient

batch, batch, getApplicationName, getBaseUrl, getGoogleClientRequestInitializer, getRequestFactory, getRootUrl, getServicePath, getSuppressPatternChecks, getSuppressRequiredParameterChecks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ROOT_URL

public static final java.lang.String DEFAULT_ROOT_URL

The default encoded root URL of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.7

See Also:

Constant Field Values

DEFAULT_SERVICE_PATH

public static final java.lang.String DEFAULT_SERVICE_PATH

The default encoded service path of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.7

See Also:

Constant Field Values

DEFAULT_BATCH_PATH

public static final java.lang.String DEFAULT_BATCH_PATH

The default encoded batch path of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.23

See Also:

Constant Field Values

DEFAULT_BASE_URL

public static final java.lang.String DEFAULT_BASE_URL

The default encoded base URL of the service. This is determined when the library is generated and normally should not be changed.

See Also:

Constant Field Values

Constructor Detail

CloudSearch

public CloudSearch(com.google.api.client.http.HttpTransport transport,
                   com.google.api.client.json.JsonFactory jsonFactory,
                   com.google.api.client.http.HttpRequestInitializer httpRequestInitializer)

Constructor.

Use CloudSearch.Builder if you need to specify any of the optional parameters.

Parameters:

transport - HTTP transport, which should normally be:

• Google App Engine: com.google.api.client.extensions.appengine.http.UrlFetchTransport
• Android: newCompatibleTransport from com.google.api.client.extensions.android.http.AndroidHttp
• Java: com.google.api.client.googleapis.javanet.GoogleNetHttpTransport#newTrustedTransport()

jsonFactory - JSON factory, which may be:

• Jackson: com.google.api.client.json.jackson2.JacksonFactory
• Google GSON: com.google.api.client.json.gson.GsonFactory
• Android Honeycomb or higher: com.google.api.client.extensions.android.json.AndroidJsonFactory

httpRequestInitializer - HTTP request initializer or null for none

Since:

1.7

Method Detail

initialize

protected void initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest<?> httpClientRequest)
                   throws java.io.IOException

Overrides:

initialize in class com.google.api.client.googleapis.services.AbstractGoogleClient

Throws:

java.io.IOException

debug

public CloudSearch.Debug debug()

An accessor for creating requests from the Debug collection.

The typical use is:

    CloudSearch cloudsearch = new CloudSearch(...);
    CloudSearch.Debug.List request = cloudsearch.debug().list(parameters ...)
 

Returns:

the resource collection

indexing

public CloudSearch.Indexing indexing()

An accessor for creating requests from the Indexing collection.

The typical use is:

    CloudSearch cloudsearch = new CloudSearch(...);
    CloudSearch.Indexing.List request = cloudsearch.indexing().list(parameters ...)
 

Returns:

the resource collection

media

public CloudSearch.Media media()

An accessor for creating requests from the Media collection.

The typical use is:

    CloudSearch cloudsearch = new CloudSearch(...);
    CloudSearch.Media.List request = cloudsearch.media().list(parameters ...)
 

Returns:

the resource collection

operations

public CloudSearch.Operations operations()

An accessor for creating requests from the Operations collection.

The typical use is:

    CloudSearch cloudsearch = new CloudSearch(...);
    CloudSearch.Operations.List request = cloudsearch.operations().list(parameters ...)
 

Returns:

the resource collection

query

public CloudSearch.Query query()

An accessor for creating requests from the Query collection.

The typical use is:

    CloudSearch cloudsearch = new CloudSearch(...);
    CloudSearch.Query.List request = cloudsearch.query().list(parameters ...)
 

Returns:

the resource collection

settings

public CloudSearch.Settings settings()

An accessor for creating requests from the Settings collection.

The typical use is:

    CloudSearch cloudsearch = new CloudSearch(...);
    CloudSearch.Settings.List request = cloudsearch.settings().list(parameters ...)
 

Returns:

the resource collection

stats

public CloudSearch.Stats stats()

An accessor for creating requests from the Stats collection.

The typical use is:

    CloudSearch cloudsearch = new CloudSearch(...);
    CloudSearch.Stats.List request = cloudsearch.stats().list(parameters ...)
 

Returns:

the resource collection