target.apidocs.com.google.api.services.dataflow.Dataflow.Projects.Locations.Jobs.GetExecutionDetails.html Maven / Gradle / Ivy
Dataflow.Projects.Locations.Jobs.GetExecutionDetails (Dataflow API v1b3-rev20231112-2.0.0)
com.google.api.services.dataflow
Class Dataflow.Projects.Locations.Jobs.GetExecutionDetails
- 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.dataflow.DataflowRequest<JobExecutionDetails>
-
- com.google.api.services.dataflow.Dataflow.Projects.Locations.Jobs.GetExecutionDetails
-
- Enclosing class:
- Dataflow.Projects.Locations.Jobs
public class Dataflow.Projects.Locations.Jobs.GetExecutionDetails
extends DataflowRequest<JobExecutionDetails>
-
-
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
GetExecutionDetails(String projectId,
String location,
String jobId)
Request detailed information about the execution status of the job.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse
executeUsingHead()
String
getJobId()
The job to get execution details for.
String
getLocation()
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
contains the job specified by job_id.
Integer
getPageSize()
If specified, determines the maximum number of stages to return.
String
getPageToken()
If supplied, this should be the value of next_page_token returned by an earlier call.
String
getProjectId()
A project id.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
set(String parameterName,
Object value)
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
set$Xgafv(String $Xgafv)
V1 error format.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setAccessToken(String accessToken)
OAuth access token.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setAlt(String alt)
Data format for response.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setCallback(String callback)
JSONP
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setFields(String fields)
Selector specifying which fields to include in a partial response.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setJobId(String jobId)
The job to get execution details for.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setKey(String key)
API key.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setLocation(String location)
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-
endpoints) that contains the job specified by job_id.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setPageSize(Integer pageSize)
If specified, determines the maximum number of stages to return.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setPageToken(String pageToken)
If supplied, this should be the value of next_page_token returned by an earlier call.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setProjectId(String projectId)
A project id.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Dataflow.Projects.Locations.Jobs.GetExecutionDetails
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
-
Methods inherited from class com.google.api.services.dataflow.DataflowRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders
-
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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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
-
GetExecutionDetails
protected GetExecutionDetails(String projectId,
String location,
String jobId)
Request detailed information about the execution status of the job. EXPERIMENTAL. This API is
subject to change or removal without notice.
Create a request for the method "jobs.getExecutionDetails".
This request holds the parameters needed by the the dataflow server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote
operation. GetExecutionDetails#initialize(com.google.api.client.googleapis.services.
AbstractGoogleClientRequest)
must be called to initialize this instance immediately after
invoking the constructor.
- Parameters:
projectId
- A project id.
location
- The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
contains the job specified by job_id.
jobId
- The job to get execution details for.
- Since:
- 1.13
-
Method Detail
-
executeUsingHead
public com.google.api.client.http.HttpResponse executeUsingHead()
throws IOException
- Overrides:
executeUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<JobExecutionDetails>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<JobExecutionDetails>
- Throws:
IOException
-
set$Xgafv
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails set$Xgafv(String $Xgafv)
Description copied from class: DataflowRequest
V1 error format.
- Overrides:
set$Xgafv
in class DataflowRequest<JobExecutionDetails>
-
setAccessToken
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setAccessToken(String accessToken)
Description copied from class: DataflowRequest
OAuth access token.
- Overrides:
setAccessToken
in class DataflowRequest<JobExecutionDetails>
-
setAlt
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setAlt(String alt)
Description copied from class: DataflowRequest
Data format for response.
- Overrides:
setAlt
in class DataflowRequest<JobExecutionDetails>
-
setCallback
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setCallback(String callback)
Description copied from class: DataflowRequest
JSONP
- Overrides:
setCallback
in class DataflowRequest<JobExecutionDetails>
-
setFields
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setFields(String fields)
Description copied from class: DataflowRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class DataflowRequest<JobExecutionDetails>
-
setKey
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setKey(String key)
Description copied from class: DataflowRequest
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.
- Overrides:
setKey
in class DataflowRequest<JobExecutionDetails>
-
setOauthToken
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setOauthToken(String oauthToken)
Description copied from class: DataflowRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class DataflowRequest<JobExecutionDetails>
-
setPrettyPrint
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setPrettyPrint(Boolean prettyPrint)
Description copied from class: DataflowRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class DataflowRequest<JobExecutionDetails>
-
setQuotaUser
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setQuotaUser(String quotaUser)
Description copied from class: DataflowRequest
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.
- Overrides:
setQuotaUser
in class DataflowRequest<JobExecutionDetails>
-
setUploadType
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setUploadType(String uploadType)
Description copied from class: DataflowRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class DataflowRequest<JobExecutionDetails>
-
setUploadProtocol
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setUploadProtocol(String uploadProtocol)
Description copied from class: DataflowRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class DataflowRequest<JobExecutionDetails>
-
getProjectId
public String getProjectId()
A project id.
-
setProjectId
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setProjectId(String projectId)
A project id.
-
getLocation
public String getLocation()
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
contains the job specified by job_id.
-
setLocation
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setLocation(String location)
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-
endpoints) that contains the job specified by job_id.
-
getJobId
public String getJobId()
The job to get execution details for.
-
setJobId
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setJobId(String jobId)
The job to get execution details for.
-
getPageSize
public Integer getPageSize()
If specified, determines the maximum number of stages to return. If unspecified, the service may
choose an appropriate default, or may return an arbitrarily large number of results.
-
setPageSize
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setPageSize(Integer pageSize)
If specified, determines the maximum number of stages to return. If unspecified, the
service may choose an appropriate default, or may return an arbitrarily large number of
results.
-
getPageToken
public String getPageToken()
If supplied, this should be the value of next_page_token returned by an earlier call. This will
cause the next page of results to be returned.
-
setPageToken
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails setPageToken(String pageToken)
If supplied, this should be the value of next_page_token returned by an earlier call.
This will cause the next page of results to be returned.
-
set
public Dataflow.Projects.Locations.Jobs.GetExecutionDetails set(String parameterName,
Object value)
- Overrides:
set
in class DataflowRequest<JobExecutionDetails>
Copyright © 2011–2023 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy