Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails (Dataflow API v1b3-rev20210818-1.32.1)

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<StageExecutionDetails>
        
        com.google.api.services.dataflow.Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails

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

Enclosing class:: Dataflow.Projects.Locations.Jobs.Stages

public class Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails
extends DataflowRequest<StageExecutionDetails>

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>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GetExecutionDetails(String projectId, String location, String jobId, String stageId)` Request detailed information about the execution status of a stage of the job.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getEndTime()` Upper time bound of work items to include, by start time.
`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 work items 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.
`String`	`getStageId()` The stage for which to fetch information.
`String`	`getStartTime()` Lower time bound of work items to include, by start time.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`set(String parameterName, Object value)`
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`set$Xgafv(String $Xgafv)` V1 error format.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setAccessToken(String accessToken)` OAuth access token.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setAlt(String alt)` Data format for response.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setCallback(String callback)` JSONP
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setEndTime(String endTime)` Upper time bound of work items to include, by start time.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setJobId(String jobId)` The job to get execution details for.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setKey(String key)` API key.
`Dataflow.Projects.Locations.Jobs.Stages.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.Stages.GetExecutionDetails`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setPageSize(Integer pageSize)` If specified, determines the maximum number of work items to return.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setPageToken(String pageToken)` If supplied, this should be the value of next_page_token returned by an earlier call.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setProjectId(String projectId)` A project id.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setStageId(String stageId)` The stage for which to fetch information.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setStartTime(String startTime)` Lower time bound of work items to include, by start time.
`Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Dataflow.Projects.Locations.Jobs.Stages.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.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,
                              String stageId)
```
    Request detailed information about the execution status of a stage of the job. EXPERIMENTAL. This API is subject to change or removal without notice. Create a request for the method "stages.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.
    
    stageId - The stage for which to fetch information.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<StageExecutionDetails>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<StageExecutionDetails>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails set$Xgafv(String $Xgafv)
```
    Description copied from class: DataflowRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DataflowRequest<StageExecutionDetails>
  - setAccessToken
```
public Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails setAccessToken(String accessToken)
```
    Description copied from class: DataflowRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DataflowRequest<StageExecutionDetails>
  - setAlt
```
public Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails setAlt(String alt)
```
    Description copied from class: DataflowRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DataflowRequest<StageExecutionDetails>
  - setCallback
```
public Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails setCallback(String callback)
```
    Description copied from class: DataflowRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DataflowRequest<StageExecutionDetails>
  - setFields
```
public Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails setFields(String fields)
```
    Description copied from class: DataflowRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DataflowRequest<StageExecutionDetails>
  - setKey
```
public Dataflow.Projects.Locations.Jobs.Stages.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<StageExecutionDetails>
  - setOauthToken
```
public Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails setOauthToken(String oauthToken)
```
    Description copied from class: DataflowRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DataflowRequest<StageExecutionDetails>
  - setPrettyPrint
```
public Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DataflowRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DataflowRequest<StageExecutionDetails>
  - setQuotaUser
```
public Dataflow.Projects.Locations.Jobs.Stages.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<StageExecutionDetails>
  - setUploadType
```
public Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails setUploadType(String uploadType)
```
    Description copied from class: DataflowRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DataflowRequest<StageExecutionDetails>
  - setUploadProtocol
```
public Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DataflowRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DataflowRequest<StageExecutionDetails>
  - getProjectId
```
public String getProjectId()
```
    A project id.
  - setProjectId
```
public Dataflow.Projects.Locations.Jobs.Stages.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.Stages.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.Stages.GetExecutionDetails setJobId(String jobId)
```
    The job to get execution details for.
  - getStageId
```
public String getStageId()
```
    The stage for which to fetch information.
  - setStageId
```
public Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails setStageId(String stageId)
```
    The stage for which to fetch information.
  - getEndTime
```
public String getEndTime()
```
    Upper time bound of work items to include, by start time.
  - setEndTime
```
public Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails setEndTime(String endTime)
```
    Upper time bound of work items to include, by start time.
  - getPageSize
```
public Integer getPageSize()
```
    If specified, determines the maximum number of work items 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.Stages.GetExecutionDetails setPageSize(Integer pageSize)
```
    If specified, determines the maximum number of work items 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.Stages.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.
  - getStartTime
```
public String getStartTime()
```
    Lower time bound of work items to include, by start time.
  - setStartTime
```
public Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails setStartTime(String startTime)
```
    Lower time bound of work items to include, by start time.
  - set
```
public Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails set(String parameterName,
                                                                       Object value)
```
    Overrides:
    
    set in class DataflowRequest<StageExecutionDetails>

Class Dataflow.Projects.Locations.Jobs.Stages.GetExecutionDetails

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.dataflow.DataflowRequest

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

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

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GetExecutionDetails

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getProjectId

setProjectId

getLocation

setLocation

getJobId

setJobId

getStageId

setStageId

getEndTime

setEndTime

getPageSize

setPageSize

getPageToken

setPageToken

getStartTime

setStartTime

set