• Home
• com.google.apis
• google-api-services-batch
• v1-rev20241204-2.0.0
• source code
• BatchRequest.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.batch.v1.BatchRequest.html Maven / Gradle / Ivy

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.batch.v1
Class BatchRequest<T>



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>


com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>


com.google.api.services.batch.v1.BatchRequest<T>















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


Direct Known Subclasses:
Batch.Projects.Locations.Get, Batch.Projects.Locations.Jobs.Create, Batch.Projects.Locations.Jobs.Delete, Batch.Projects.Locations.Jobs.Get, Batch.Projects.Locations.Jobs.List, Batch.Projects.Locations.Jobs.TaskGroups.Tasks.Get, Batch.Projects.Locations.Jobs.TaskGroups.Tasks.List, Batch.Projects.Locations.List, Batch.Projects.Locations.Operations.Cancel, Batch.Projects.Locations.Operations.Delete, Batch.Projects.Locations.Operations.Get, Batch.Projects.Locations.Operations.List, Batch.Projects.Locations.State.Report




public abstract class BatchRequest<T>
extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
Batch request.

Since:
1.3












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>








Field Summary




Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
API_VERSION_HEADER, USER_AGENT_SUFFIX








Constructor Summary

Constructors 

Constructor and Description


BatchRequest(Batch client,
            String method,
            String uriTemplate,
            Object content,
            Class<T> responseClass) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


String
get$Xgafv()
V1 error format.



Batch
getAbstractGoogleClient() 


String
getAccessToken()
OAuth access token.



String
getAlt()
Data format for response.



String
getCallback()
JSONP



String
getFields()
Selector specifying which fields to include in a partial response.



String
getKey()
API key.



String
getOauthToken()
OAuth 2.0 token for the current user.



Boolean
getPrettyPrint()
Returns response with indentations and line breaks.



String
getQuotaUser()
Available to use for quota purposes for server-side applications.



String
getUploadProtocol()
Upload protocol for media (e.g.



String
getUploadType()
Legacy upload protocol for media (e.g.



BatchRequest<T>
set(String parameterName,
   Object value) 


BatchRequest<T>
set$Xgafv(String $Xgafv)
V1 error format.



BatchRequest<T>
setAccessToken(String accessToken)
OAuth access token.



BatchRequest<T>
setAlt(String alt)
Data format for response.



BatchRequest<T>
setCallback(String callback)
JSONP



BatchRequest<T>
setDisableGZipContent(boolean disableGZipContent) 


BatchRequest<T>
setFields(String fields)
Selector specifying which fields to include in a partial response.



BatchRequest<T>
setKey(String key)
API key.



BatchRequest<T>
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.



BatchRequest<T>
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



BatchRequest<T>
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.



BatchRequest<T>
setRequestHeaders(com.google.api.client.http.HttpHeaders headers) 


BatchRequest<T>
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.



BatchRequest<T>
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.







Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue





Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream





Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString





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





BatchRequest
public BatchRequest(Batch client,
                    String method,
                    String uriTemplate,
                    Object content,
                    Class<T> responseClass)

Parameters:
client - Google client
method - HTTP Method
uriTemplate - URI template for the path relative to the base URL. If it starts with a "/"
        the base path from the base URL will be stripped out. The URI template can also be a
        full URL. URI template expansion is done using
        UriTemplate.expand(String, String, Object, boolean)
content - A POJO that can be serialized into JSON or null for none
responseClass - response class to parse into










Method Detail





get$Xgafv
public String get$Xgafv()
V1 error format.







set$Xgafv
public BatchRequest<T> set$Xgafv(String $Xgafv)
V1 error format.







getAccessToken
public String getAccessToken()
OAuth access token.







setAccessToken
public BatchRequest<T> setAccessToken(String accessToken)
OAuth access token.







getAlt
public String getAlt()
Data format for response. [default: json]







setAlt
public BatchRequest<T> setAlt(String alt)
Data format for response.







getCallback
public String getCallback()
JSONP







setCallback
public BatchRequest<T> setCallback(String callback)
JSONP







getFields
public String getFields()
Selector specifying which fields to include in a partial response.







setFields
public BatchRequest<T> setFields(String fields)
Selector specifying which fields to include in a partial response.







getKey
public String getKey()
API key. Your API key identifies your project and provides you with API access, quota, and
 reports. Required unless you provide an OAuth 2.0 token.







setKey
public BatchRequest<T> setKey(String key)
API key. Your API key identifies your project and provides you with API access, quota, and
 reports. Required unless you provide an OAuth 2.0 token.







getOauthToken
public String getOauthToken()
OAuth 2.0 token for the current user.







setOauthToken
public BatchRequest<T> setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.







getPrettyPrint
public Boolean getPrettyPrint()
Returns response with indentations and line breaks. [default: true]







setPrettyPrint
public BatchRequest<T> setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.







getQuotaUser
public String getQuotaUser()
Available to use for quota purposes for server-side applications. Can be any arbitrary string
 assigned to a user, but should not exceed 40 characters.







setQuotaUser
public BatchRequest<T> setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications. Can be any arbitrary string
 assigned to a user, but should not exceed 40 characters.







getUploadType
public String getUploadType()
Legacy upload protocol for media (e.g. "media", "multipart").







setUploadType
public BatchRequest<T> setUploadType(String uploadType)
Legacy upload protocol for media (e.g. "media", "multipart").







getUploadProtocol
public String getUploadProtocol()
Upload protocol for media (e.g. "raw", "multipart").







setUploadProtocol
public BatchRequest<T> setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g. "raw", "multipart").







getAbstractGoogleClient
public final Batch getAbstractGoogleClient()

Overrides:
getAbstractGoogleClient in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>








setDisableGZipContent
public BatchRequest<T> setDisableGZipContent(boolean disableGZipContent)

Overrides:
setDisableGZipContent in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>








setRequestHeaders
public BatchRequest<T> setRequestHeaders(com.google.api.client.http.HttpHeaders headers)

Overrides:
setRequestHeaders in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>








set
public BatchRequest<T> set(String parameterName,
                           Object value)

Overrides:
set in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>














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.