All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.api.services.dataflow.Dataflow Maven / Gradle / Ivy

There is a newer version: v1b4-rev7-1.20.0
Show newest version
/*
 * Copyright 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://code.google.com/p/google-apis-client-generator/
 * (build: 2016-04-08 17:16:44 UTC)
 * on 2016-04-27 at 00:23:15 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.dataflow;

/**
 * Service definition for Dataflow (v1b3).
 *
 * 

* Develops and executes data processing patterns like ETL, batch computation, and continuous computation. *

* *

* For more information about this service, see the * API Documentation *

* *

* This service uses {@link DataflowRequestInitializer} to initialize global parameters via its * {@link Builder}. *

* * @since 1.3 * @author Google, Inc. */ @SuppressWarnings("javadoc") public class Dataflow extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient { // Note: Leave this static initializer at the top of the file. static { com.google.api.client.util.Preconditions.checkState( com.google.api.client.googleapis.GoogleUtils.MAJOR_VERSION == 1 && com.google.api.client.googleapis.GoogleUtils.MINOR_VERSION >= 15, "You are currently running with version %s of google-api-client. " + "You need at least version 1.15 of google-api-client to run version " + "1.18.0-rc of the Google Dataflow API library.", com.google.api.client.googleapis.GoogleUtils.VERSION); } /** * 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 */ public static final String DEFAULT_ROOT_URL = "https://dataflow.googleapis.com/"; /** * 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 */ public static final String DEFAULT_SERVICE_PATH = ""; /** * The default encoded base URL of the service. This is determined when the library is generated * and normally should not be changed. */ public static final String DEFAULT_BASE_URL = DEFAULT_ROOT_URL + DEFAULT_SERVICE_PATH; /** * Constructor. * *

* Use {@link Builder} if you need to specify any of the optional parameters. *

* * @param transport HTTP transport, which should normally be: *
    *
  • Google App Engine: * {@code com.google.api.client.extensions.appengine.http.UrlFetchTransport}
  • *
  • Android: {@code newCompatibleTransport} from * {@code com.google.api.client.extensions.android.http.AndroidHttp}
  • *
  • Java: {@link com.google.api.client.googleapis.javanet.GoogleNetHttpTransport#newTrustedTransport()} *
  • *
* @param jsonFactory JSON factory, which may be: *
    *
  • Jackson: {@code com.google.api.client.json.jackson2.JacksonFactory}
  • *
  • Google GSON: {@code com.google.api.client.json.gson.GsonFactory}
  • *
  • Android Honeycomb or higher: * {@code com.google.api.client.extensions.android.json.AndroidJsonFactory}
  • *
* @param httpRequestInitializer HTTP request initializer or {@code null} for none * @since 1.7 */ public Dataflow(com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory, com.google.api.client.http.HttpRequestInitializer httpRequestInitializer) { this(new Builder(transport, jsonFactory, httpRequestInitializer)); } /** * @param builder builder */ Dataflow(Builder builder) { super(builder); } @Override protected void initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest httpClientRequest) throws java.io.IOException { super.initialize(httpClientRequest); } /** * An accessor for creating requests from the Projects collection. * *

The typical use is:

*
   *   {@code Dataflow dataflow = new Dataflow(...);}
   *   {@code Dataflow.Projects.List request = dataflow.projects().list(parameters ...)}
   * 
* * @return the resource collection */ public Projects projects() { return new Projects(); } /** * The "projects" collection of methods. */ public class Projects { /** * Send a worker_message to the service. * * Create a request for the method "projects.workerMessages". * * This request holds the parameters needed by the dataflow server. After setting any optional * parameters, call the {@link WorkerMessages#execute()} method to invoke the remote operation. * * @param projectId The project to send the WorkerMessages to. * @param content the {@link com.google.api.services.dataflow.model.SendWorkerMessagesRequest} * @return the request */ public WorkerMessages workerMessages(java.lang.String projectId, com.google.api.services.dataflow.model.SendWorkerMessagesRequest content) throws java.io.IOException { WorkerMessages result = new WorkerMessages(projectId, content); initialize(result); return result; } public class WorkerMessages extends DataflowRequest { private static final String REST_PATH = "v1b3/projects/{projectId}/WorkerMessages"; /** * Send a worker_message to the service. * * Create a request for the method "projects.workerMessages". * * This request holds the parameters needed by the the dataflow server. After setting any * optional parameters, call the {@link WorkerMessages#execute()} method to invoke the remote * operation.

{@link WorkerMessages#initialize(com.google.api.client.googleapis.services.Abstr * actGoogleClientRequest)} must be called to initialize this instance immediately after invoking * the constructor.

* * @param projectId The project to send the WorkerMessages to. * @param content the {@link com.google.api.services.dataflow.model.SendWorkerMessagesRequest} * @since 1.13 */ protected WorkerMessages(java.lang.String projectId, com.google.api.services.dataflow.model.SendWorkerMessagesRequest content) { super(Dataflow.this, "POST", REST_PATH, content, com.google.api.services.dataflow.model.SendWorkerMessagesResponse.class); this.projectId = com.google.api.client.util.Preconditions.checkNotNull(projectId, "Required parameter projectId must be specified."); } @Override public WorkerMessages set$Xgafv(java.lang.String $Xgafv) { return (WorkerMessages) super.set$Xgafv($Xgafv); } @Override public WorkerMessages setAccessToken(java.lang.String accessToken) { return (WorkerMessages) super.setAccessToken(accessToken); } @Override public WorkerMessages setAlt(java.lang.String alt) { return (WorkerMessages) super.setAlt(alt); } @Override public WorkerMessages setBearerToken(java.lang.String bearerToken) { return (WorkerMessages) super.setBearerToken(bearerToken); } @Override public WorkerMessages setCallback(java.lang.String callback) { return (WorkerMessages) super.setCallback(callback); } @Override public WorkerMessages setFields(java.lang.String fields) { return (WorkerMessages) super.setFields(fields); } @Override public WorkerMessages setKey(java.lang.String key) { return (WorkerMessages) super.setKey(key); } @Override public WorkerMessages setOauthToken(java.lang.String oauthToken) { return (WorkerMessages) super.setOauthToken(oauthToken); } @Override public WorkerMessages setPp(java.lang.Boolean pp) { return (WorkerMessages) super.setPp(pp); } @Override public WorkerMessages setPrettyPrint(java.lang.Boolean prettyPrint) { return (WorkerMessages) super.setPrettyPrint(prettyPrint); } @Override public WorkerMessages setQuotaUser(java.lang.String quotaUser) { return (WorkerMessages) super.setQuotaUser(quotaUser); } @Override public WorkerMessages setUploadType(java.lang.String uploadType) { return (WorkerMessages) super.setUploadType(uploadType); } @Override public WorkerMessages setUploadProtocol(java.lang.String uploadProtocol) { return (WorkerMessages) super.setUploadProtocol(uploadProtocol); } /** The project to send the WorkerMessages to. */ @com.google.api.client.util.Key private java.lang.String projectId; /** The project to send the WorkerMessages to. */ public java.lang.String getProjectId() { return projectId; } /** The project to send the WorkerMessages to. */ public WorkerMessages setProjectId(java.lang.String projectId) { this.projectId = projectId; return this; } @Override public WorkerMessages set(String parameterName, Object value) { return (WorkerMessages) super.set(parameterName, value); } } /** * An accessor for creating requests from the Jobs collection. * *

The typical use is:

*
     *   {@code Dataflow dataflow = new Dataflow(...);}
     *   {@code Dataflow.Jobs.List request = dataflow.jobs().list(parameters ...)}
     * 
* * @return the resource collection */ public Jobs jobs() { return new Jobs(); } /** * The "jobs" collection of methods. */ public class Jobs { /** * Creates a dataflow job. * * Create a request for the method "jobs.create". * * This request holds the parameters needed by the dataflow server. After setting any optional * parameters, call the {@link Create#execute()} method to invoke the remote operation. * * @param projectId The project which owns the job. * @param content the {@link com.google.api.services.dataflow.model.Job} * @return the request */ public Create create(java.lang.String projectId, com.google.api.services.dataflow.model.Job content) throws java.io.IOException { Create result = new Create(projectId, content); initialize(result); return result; } public class Create extends DataflowRequest { private static final String REST_PATH = "v1b3/projects/{projectId}/jobs"; /** * Creates a dataflow job. * * Create a request for the method "jobs.create". * * This request holds the parameters needed by the the dataflow server. After setting any * optional parameters, call the {@link Create#execute()} method to invoke the remote operation. *

{@link * Create#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)} must * be called to initialize this instance immediately after invoking the constructor.

* * @param projectId The project which owns the job. * @param content the {@link com.google.api.services.dataflow.model.Job} * @since 1.13 */ protected Create(java.lang.String projectId, com.google.api.services.dataflow.model.Job content) { super(Dataflow.this, "POST", REST_PATH, content, com.google.api.services.dataflow.model.Job.class); this.projectId = com.google.api.client.util.Preconditions.checkNotNull(projectId, "Required parameter projectId must be specified."); } @Override public Create set$Xgafv(java.lang.String $Xgafv) { return (Create) super.set$Xgafv($Xgafv); } @Override public Create setAccessToken(java.lang.String accessToken) { return (Create) super.setAccessToken(accessToken); } @Override public Create setAlt(java.lang.String alt) { return (Create) super.setAlt(alt); } @Override public Create setBearerToken(java.lang.String bearerToken) { return (Create) super.setBearerToken(bearerToken); } @Override public Create setCallback(java.lang.String callback) { return (Create) super.setCallback(callback); } @Override public Create setFields(java.lang.String fields) { return (Create) super.setFields(fields); } @Override public Create setKey(java.lang.String key) { return (Create) super.setKey(key); } @Override public Create setOauthToken(java.lang.String oauthToken) { return (Create) super.setOauthToken(oauthToken); } @Override public Create setPp(java.lang.Boolean pp) { return (Create) super.setPp(pp); } @Override public Create setPrettyPrint(java.lang.Boolean prettyPrint) { return (Create) super.setPrettyPrint(prettyPrint); } @Override public Create setQuotaUser(java.lang.String quotaUser) { return (Create) super.setQuotaUser(quotaUser); } @Override public Create setUploadType(java.lang.String uploadType) { return (Create) super.setUploadType(uploadType); } @Override public Create setUploadProtocol(java.lang.String uploadProtocol) { return (Create) super.setUploadProtocol(uploadProtocol); } /** The project which owns the job. */ @com.google.api.client.util.Key private java.lang.String projectId; /** The project which owns the job. */ public java.lang.String getProjectId() { return projectId; } /** The project which owns the job. */ public Create setProjectId(java.lang.String projectId) { this.projectId = projectId; return this; } /** Level of information requested in response. */ @com.google.api.client.util.Key private java.lang.String view; /** Level of information requested in response. */ public java.lang.String getView() { return view; } /** Level of information requested in response. */ public Create setView(java.lang.String view) { this.view = view; return this; } /** DEPRECATED. This field is now on the Job message. */ @com.google.api.client.util.Key private java.lang.String replaceJobId; /** DEPRECATED. This field is now on the Job message. */ public java.lang.String getReplaceJobId() { return replaceJobId; } /** DEPRECATED. This field is now on the Job message. */ public Create setReplaceJobId(java.lang.String replaceJobId) { this.replaceJobId = replaceJobId; return this; } @Override public Create set(String parameterName, Object value) { return (Create) super.set(parameterName, value); } } /** * Gets the state of the specified dataflow job. * * Create a request for the method "jobs.get". * * This request holds the parameters needed by the dataflow server. After setting any optional * parameters, call the {@link Get#execute()} method to invoke the remote operation. * * @param projectId The project which owns the job. * @param jobId Identifies a single job. * @return the request */ public Get get(java.lang.String projectId, java.lang.String jobId) throws java.io.IOException { Get result = new Get(projectId, jobId); initialize(result); return result; } public class Get extends DataflowRequest { private static final String REST_PATH = "v1b3/projects/{projectId}/jobs/{jobId}"; /** * Gets the state of the specified dataflow job. * * Create a request for the method "jobs.get". * * This request holds the parameters needed by the the dataflow server. After setting any * optional parameters, call the {@link Get#execute()} method to invoke the remote operation.

* {@link Get#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)} * must be called to initialize this instance immediately after invoking the constructor.

* * @param projectId The project which owns the job. * @param jobId Identifies a single job. * @since 1.13 */ protected Get(java.lang.String projectId, java.lang.String jobId) { super(Dataflow.this, "GET", REST_PATH, null, com.google.api.services.dataflow.model.Job.class); this.projectId = com.google.api.client.util.Preconditions.checkNotNull(projectId, "Required parameter projectId must be specified."); this.jobId = com.google.api.client.util.Preconditions.checkNotNull(jobId, "Required parameter jobId must be specified."); } @Override public com.google.api.client.http.HttpResponse executeUsingHead() throws java.io.IOException { return super.executeUsingHead(); } @Override public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead() throws java.io.IOException { return super.buildHttpRequestUsingHead(); } @Override public Get set$Xgafv(java.lang.String $Xgafv) { return (Get) super.set$Xgafv($Xgafv); } @Override public Get setAccessToken(java.lang.String accessToken) { return (Get) super.setAccessToken(accessToken); } @Override public Get setAlt(java.lang.String alt) { return (Get) super.setAlt(alt); } @Override public Get setBearerToken(java.lang.String bearerToken) { return (Get) super.setBearerToken(bearerToken); } @Override public Get setCallback(java.lang.String callback) { return (Get) super.setCallback(callback); } @Override public Get setFields(java.lang.String fields) { return (Get) super.setFields(fields); } @Override public Get setKey(java.lang.String key) { return (Get) super.setKey(key); } @Override public Get setOauthToken(java.lang.String oauthToken) { return (Get) super.setOauthToken(oauthToken); } @Override public Get setPp(java.lang.Boolean pp) { return (Get) super.setPp(pp); } @Override public Get setPrettyPrint(java.lang.Boolean prettyPrint) { return (Get) super.setPrettyPrint(prettyPrint); } @Override public Get setQuotaUser(java.lang.String quotaUser) { return (Get) super.setQuotaUser(quotaUser); } @Override public Get setUploadType(java.lang.String uploadType) { return (Get) super.setUploadType(uploadType); } @Override public Get setUploadProtocol(java.lang.String uploadProtocol) { return (Get) super.setUploadProtocol(uploadProtocol); } /** The project which owns the job. */ @com.google.api.client.util.Key private java.lang.String projectId; /** The project which owns the job. */ public java.lang.String getProjectId() { return projectId; } /** The project which owns the job. */ public Get setProjectId(java.lang.String projectId) { this.projectId = projectId; return this; } /** Identifies a single job. */ @com.google.api.client.util.Key private java.lang.String jobId; /** Identifies a single job. */ public java.lang.String getJobId() { return jobId; } /** Identifies a single job. */ public Get setJobId(java.lang.String jobId) { this.jobId = jobId; return this; } /** Level of information requested in response. */ @com.google.api.client.util.Key private java.lang.String view; /** Level of information requested in response. */ public java.lang.String getView() { return view; } /** Level of information requested in response. */ public Get setView(java.lang.String view) { this.view = view; return this; } @Override public Get set(String parameterName, Object value) { return (Get) super.set(parameterName, value); } } /** * Request the job status. * * Create a request for the method "jobs.getMetrics". * * This request holds the parameters needed by the dataflow server. After setting any optional * parameters, call the {@link GetMetrics#execute()} method to invoke the remote operation. * * @param projectId A project id. * @param jobId The job to get messages for. * @return the request */ public GetMetrics getMetrics(java.lang.String projectId, java.lang.String jobId) throws java.io.IOException { GetMetrics result = new GetMetrics(projectId, jobId); initialize(result); return result; } public class GetMetrics extends DataflowRequest { private static final String REST_PATH = "v1b3/projects/{projectId}/jobs/{jobId}/metrics"; /** * Request the job status. * * Create a request for the method "jobs.getMetrics". * * This request holds the parameters needed by the the dataflow server. After setting any * optional parameters, call the {@link GetMetrics#execute()} method to invoke the remote * operation.

{@link * GetMetrics#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)} * must be called to initialize this instance immediately after invoking the constructor.

* * @param projectId A project id. * @param jobId The job to get messages for. * @since 1.13 */ protected GetMetrics(java.lang.String projectId, java.lang.String jobId) { super(Dataflow.this, "GET", REST_PATH, null, com.google.api.services.dataflow.model.JobMetrics.class); this.projectId = com.google.api.client.util.Preconditions.checkNotNull(projectId, "Required parameter projectId must be specified."); this.jobId = com.google.api.client.util.Preconditions.checkNotNull(jobId, "Required parameter jobId must be specified."); } @Override public com.google.api.client.http.HttpResponse executeUsingHead() throws java.io.IOException { return super.executeUsingHead(); } @Override public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead() throws java.io.IOException { return super.buildHttpRequestUsingHead(); } @Override public GetMetrics set$Xgafv(java.lang.String $Xgafv) { return (GetMetrics) super.set$Xgafv($Xgafv); } @Override public GetMetrics setAccessToken(java.lang.String accessToken) { return (GetMetrics) super.setAccessToken(accessToken); } @Override public GetMetrics setAlt(java.lang.String alt) { return (GetMetrics) super.setAlt(alt); } @Override public GetMetrics setBearerToken(java.lang.String bearerToken) { return (GetMetrics) super.setBearerToken(bearerToken); } @Override public GetMetrics setCallback(java.lang.String callback) { return (GetMetrics) super.setCallback(callback); } @Override public GetMetrics setFields(java.lang.String fields) { return (GetMetrics) super.setFields(fields); } @Override public GetMetrics setKey(java.lang.String key) { return (GetMetrics) super.setKey(key); } @Override public GetMetrics setOauthToken(java.lang.String oauthToken) { return (GetMetrics) super.setOauthToken(oauthToken); } @Override public GetMetrics setPp(java.lang.Boolean pp) { return (GetMetrics) super.setPp(pp); } @Override public GetMetrics setPrettyPrint(java.lang.Boolean prettyPrint) { return (GetMetrics) super.setPrettyPrint(prettyPrint); } @Override public GetMetrics setQuotaUser(java.lang.String quotaUser) { return (GetMetrics) super.setQuotaUser(quotaUser); } @Override public GetMetrics setUploadType(java.lang.String uploadType) { return (GetMetrics) super.setUploadType(uploadType); } @Override public GetMetrics setUploadProtocol(java.lang.String uploadProtocol) { return (GetMetrics) super.setUploadProtocol(uploadProtocol); } /** A project id. */ @com.google.api.client.util.Key private java.lang.String projectId; /** A project id. */ public java.lang.String getProjectId() { return projectId; } /** A project id. */ public GetMetrics setProjectId(java.lang.String projectId) { this.projectId = projectId; return this; } /** The job to get messages for. */ @com.google.api.client.util.Key private java.lang.String jobId; /** The job to get messages for. */ public java.lang.String getJobId() { return jobId; } /** The job to get messages for. */ public GetMetrics setJobId(java.lang.String jobId) { this.jobId = jobId; return this; } /** * Return only metric data that has changed since this time. Default is to return all * information about all metrics for the job. */ @com.google.api.client.util.Key private java.lang.String startTime; /** Return only metric data that has changed since this time. Default is to return all information about all metrics for the job. */ public java.lang.String getStartTime() { return startTime; } /** * Return only metric data that has changed since this time. Default is to return all * information about all metrics for the job. */ public GetMetrics setStartTime(java.lang.String startTime) { this.startTime = startTime; return this; } @Override public GetMetrics set(String parameterName, Object value) { return (GetMetrics) super.set(parameterName, value); } } /** * List the jobs of a project * * Create a request for the method "jobs.list". * * This request holds the parameters needed by the dataflow server. After setting any optional * parameters, call the {@link List#execute()} method to invoke the remote operation. * * @param projectId The project which owns the jobs. * @return the request */ public List list(java.lang.String projectId) throws java.io.IOException { List result = new List(projectId); initialize(result); return result; } public class List extends DataflowRequest { private static final String REST_PATH = "v1b3/projects/{projectId}/jobs"; /** * List the jobs of a project * * Create a request for the method "jobs.list". * * This request holds the parameters needed by the the dataflow server. After setting any * optional parameters, call the {@link List#execute()} method to invoke the remote operation.

* {@link List#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)} * must be called to initialize this instance immediately after invoking the constructor.

* * @param projectId The project which owns the jobs. * @since 1.13 */ protected List(java.lang.String projectId) { super(Dataflow.this, "GET", REST_PATH, null, com.google.api.services.dataflow.model.ListJobsResponse.class); this.projectId = com.google.api.client.util.Preconditions.checkNotNull(projectId, "Required parameter projectId must be specified."); } @Override public com.google.api.client.http.HttpResponse executeUsingHead() throws java.io.IOException { return super.executeUsingHead(); } @Override public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead() throws java.io.IOException { return super.buildHttpRequestUsingHead(); } @Override public List set$Xgafv(java.lang.String $Xgafv) { return (List) super.set$Xgafv($Xgafv); } @Override public List setAccessToken(java.lang.String accessToken) { return (List) super.setAccessToken(accessToken); } @Override public List setAlt(java.lang.String alt) { return (List) super.setAlt(alt); } @Override public List setBearerToken(java.lang.String bearerToken) { return (List) super.setBearerToken(bearerToken); } @Override public List setCallback(java.lang.String callback) { return (List) super.setCallback(callback); } @Override public List setFields(java.lang.String fields) { return (List) super.setFields(fields); } @Override public List setKey(java.lang.String key) { return (List) super.setKey(key); } @Override public List setOauthToken(java.lang.String oauthToken) { return (List) super.setOauthToken(oauthToken); } @Override public List setPp(java.lang.Boolean pp) { return (List) super.setPp(pp); } @Override public List setPrettyPrint(java.lang.Boolean prettyPrint) { return (List) super.setPrettyPrint(prettyPrint); } @Override public List setQuotaUser(java.lang.String quotaUser) { return (List) super.setQuotaUser(quotaUser); } @Override public List setUploadType(java.lang.String uploadType) { return (List) super.setUploadType(uploadType); } @Override public List setUploadProtocol(java.lang.String uploadProtocol) { return (List) super.setUploadProtocol(uploadProtocol); } /** The project which owns the jobs. */ @com.google.api.client.util.Key private java.lang.String projectId; /** The project which owns the jobs. */ public java.lang.String getProjectId() { return projectId; } /** The project which owns the jobs. */ public List setProjectId(java.lang.String projectId) { this.projectId = projectId; return this; } /** The kind of filter to use. */ @com.google.api.client.util.Key private java.lang.String filter; /** The kind of filter to use. */ public java.lang.String getFilter() { return filter; } /** The kind of filter to use. */ public List setFilter(java.lang.String filter) { this.filter = filter; return this; } /** Level of information requested in response. Default is SUMMARY. */ @com.google.api.client.util.Key private java.lang.String view; /** Level of information requested in response. Default is SUMMARY. */ public java.lang.String getView() { return view; } /** Level of information requested in response. Default is SUMMARY. */ public List setView(java.lang.String view) { this.view = view; return this; } /** * If there are many jobs, limit response to at most this many. The actual number of jobs * returned will be the lesser of max_responses and an unspecified server-defined limit. */ @com.google.api.client.util.Key private java.lang.Integer pageSize; /** If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit. */ public java.lang.Integer getPageSize() { return pageSize; } /** * If there are many jobs, limit response to at most this many. The actual number of jobs * returned will be the lesser of max_responses and an unspecified server-defined limit. */ public List setPageSize(java.lang.Integer pageSize) { this.pageSize = pageSize; return this; } /** * Set this to the 'next_page_token' field of a previous response to request additional * results in a long list. */ @com.google.api.client.util.Key private java.lang.String pageToken; /** Set this to the 'next_page_token' field of a previous response to request additional results in a long list. */ public java.lang.String getPageToken() { return pageToken; } /** * Set this to the 'next_page_token' field of a previous response to request additional * results in a long list. */ public List setPageToken(java.lang.String pageToken) { this.pageToken = pageToken; return this; } @Override public List set(String parameterName, Object value) { return (List) super.set(parameterName, value); } } /** * Updates the state of an existing dataflow job. * * Create a request for the method "jobs.update". * * This request holds the parameters needed by the dataflow server. After setting any optional * parameters, call the {@link Update#execute()} method to invoke the remote operation. * * @param projectId The project which owns the job. * @param jobId Identifies a single job. * @param content the {@link com.google.api.services.dataflow.model.Job} * @return the request */ public Update update(java.lang.String projectId, java.lang.String jobId, com.google.api.services.dataflow.model.Job content) throws java.io.IOException { Update result = new Update(projectId, jobId, content); initialize(result); return result; } public class Update extends DataflowRequest { private static final String REST_PATH = "v1b3/projects/{projectId}/jobs/{jobId}"; /** * Updates the state of an existing dataflow job. * * Create a request for the method "jobs.update". * * This request holds the parameters needed by the the dataflow server. After setting any * optional parameters, call the {@link Update#execute()} method to invoke the remote operation. *

{@link * Update#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)} must * be called to initialize this instance immediately after invoking the constructor.

* * @param projectId The project which owns the job. * @param jobId Identifies a single job. * @param content the {@link com.google.api.services.dataflow.model.Job} * @since 1.13 */ protected Update(java.lang.String projectId, java.lang.String jobId, com.google.api.services.dataflow.model.Job content) { super(Dataflow.this, "PUT", REST_PATH, content, com.google.api.services.dataflow.model.Job.class); this.projectId = com.google.api.client.util.Preconditions.checkNotNull(projectId, "Required parameter projectId must be specified."); this.jobId = com.google.api.client.util.Preconditions.checkNotNull(jobId, "Required parameter jobId must be specified."); } @Override public Update set$Xgafv(java.lang.String $Xgafv) { return (Update) super.set$Xgafv($Xgafv); } @Override public Update setAccessToken(java.lang.String accessToken) { return (Update) super.setAccessToken(accessToken); } @Override public Update setAlt(java.lang.String alt) { return (Update) super.setAlt(alt); } @Override public Update setBearerToken(java.lang.String bearerToken) { return (Update) super.setBearerToken(bearerToken); } @Override public Update setCallback(java.lang.String callback) { return (Update) super.setCallback(callback); } @Override public Update setFields(java.lang.String fields) { return (Update) super.setFields(fields); } @Override public Update setKey(java.lang.String key) { return (Update) super.setKey(key); } @Override public Update setOauthToken(java.lang.String oauthToken) { return (Update) super.setOauthToken(oauthToken); } @Override public Update setPp(java.lang.Boolean pp) { return (Update) super.setPp(pp); } @Override public Update setPrettyPrint(java.lang.Boolean prettyPrint) { return (Update) super.setPrettyPrint(prettyPrint); } @Override public Update setQuotaUser(java.lang.String quotaUser) { return (Update) super.setQuotaUser(quotaUser); } @Override public Update setUploadType(java.lang.String uploadType) { return (Update) super.setUploadType(uploadType); } @Override public Update setUploadProtocol(java.lang.String uploadProtocol) { return (Update) super.setUploadProtocol(uploadProtocol); } /** The project which owns the job. */ @com.google.api.client.util.Key private java.lang.String projectId; /** The project which owns the job. */ public java.lang.String getProjectId() { return projectId; } /** The project which owns the job. */ public Update setProjectId(java.lang.String projectId) { this.projectId = projectId; return this; } /** Identifies a single job. */ @com.google.api.client.util.Key private java.lang.String jobId; /** Identifies a single job. */ public java.lang.String getJobId() { return jobId; } /** Identifies a single job. */ public Update setJobId(java.lang.String jobId) { this.jobId = jobId; return this; } @Override public Update set(String parameterName, Object value) { return (Update) super.set(parameterName, value); } } /** * An accessor for creating requests from the Messages collection. * *

The typical use is:

*
       *   {@code Dataflow dataflow = new Dataflow(...);}
       *   {@code Dataflow.Messages.List request = dataflow.messages().list(parameters ...)}
       * 
* * @return the resource collection */ public Messages messages() { return new Messages(); } /** * The "messages" collection of methods. */ public class Messages { /** * Request the job status. * * Create a request for the method "messages.list". * * This request holds the parameters needed by the dataflow server. After setting any optional * parameters, call the {@link List#execute()} method to invoke the remote operation. * * @param projectId A project id. * @param jobId The job to get messages about. * @return the request */ public List list(java.lang.String projectId, java.lang.String jobId) throws java.io.IOException { List result = new List(projectId, jobId); initialize(result); return result; } public class List extends DataflowRequest { private static final String REST_PATH = "v1b3/projects/{projectId}/jobs/{jobId}/messages"; /** * Request the job status. * * Create a request for the method "messages.list". * * This request holds the parameters needed by the the dataflow server. After setting any * optional parameters, call the {@link List#execute()} method to invoke the remote operation.

* {@link List#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)} * must be called to initialize this instance immediately after invoking the constructor.

* * @param projectId A project id. * @param jobId The job to get messages about. * @since 1.13 */ protected List(java.lang.String projectId, java.lang.String jobId) { super(Dataflow.this, "GET", REST_PATH, null, com.google.api.services.dataflow.model.ListJobMessagesResponse.class); this.projectId = com.google.api.client.util.Preconditions.checkNotNull(projectId, "Required parameter projectId must be specified."); this.jobId = com.google.api.client.util.Preconditions.checkNotNull(jobId, "Required parameter jobId must be specified."); } @Override public com.google.api.client.http.HttpResponse executeUsingHead() throws java.io.IOException { return super.executeUsingHead(); } @Override public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead() throws java.io.IOException { return super.buildHttpRequestUsingHead(); } @Override public List set$Xgafv(java.lang.String $Xgafv) { return (List) super.set$Xgafv($Xgafv); } @Override public List setAccessToken(java.lang.String accessToken) { return (List) super.setAccessToken(accessToken); } @Override public List setAlt(java.lang.String alt) { return (List) super.setAlt(alt); } @Override public List setBearerToken(java.lang.String bearerToken) { return (List) super.setBearerToken(bearerToken); } @Override public List setCallback(java.lang.String callback) { return (List) super.setCallback(callback); } @Override public List setFields(java.lang.String fields) { return (List) super.setFields(fields); } @Override public List setKey(java.lang.String key) { return (List) super.setKey(key); } @Override public List setOauthToken(java.lang.String oauthToken) { return (List) super.setOauthToken(oauthToken); } @Override public List setPp(java.lang.Boolean pp) { return (List) super.setPp(pp); } @Override public List setPrettyPrint(java.lang.Boolean prettyPrint) { return (List) super.setPrettyPrint(prettyPrint); } @Override public List setQuotaUser(java.lang.String quotaUser) { return (List) super.setQuotaUser(quotaUser); } @Override public List setUploadType(java.lang.String uploadType) { return (List) super.setUploadType(uploadType); } @Override public List setUploadProtocol(java.lang.String uploadProtocol) { return (List) super.setUploadProtocol(uploadProtocol); } /** A project id. */ @com.google.api.client.util.Key private java.lang.String projectId; /** A project id. */ public java.lang.String getProjectId() { return projectId; } /** A project id. */ public List setProjectId(java.lang.String projectId) { this.projectId = projectId; return this; } /** The job to get messages about. */ @com.google.api.client.util.Key private java.lang.String jobId; /** The job to get messages about. */ public java.lang.String getJobId() { return jobId; } /** The job to get messages about. */ public List setJobId(java.lang.String jobId) { this.jobId = jobId; return this; } /** Filter to only get messages with importance >= level */ @com.google.api.client.util.Key private java.lang.String minimumImportance; /** Filter to only get messages with importance >= level */ public java.lang.String getMinimumImportance() { return minimumImportance; } /** Filter to only get messages with importance >= level */ public List setMinimumImportance(java.lang.String minimumImportance) { this.minimumImportance = minimumImportance; return this; } /** * If specified, determines the maximum number of messages to return. If unspecified, the * service may choose an appropriate default, or may return an arbitrarily large number of * results. */ @com.google.api.client.util.Key private java.lang.Integer pageSize; /** If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results. */ public java.lang.Integer getPageSize() { return pageSize; } /** * If specified, determines the maximum number of messages to return. If unspecified, the * service may choose an appropriate default, or may return an arbitrarily large number of * results. */ public List setPageSize(java.lang.Integer pageSize) { this.pageSize = pageSize; return this; } /** * 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. */ @com.google.api.client.util.Key private java.lang.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. */ public java.lang.String getPageToken() { return 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. */ public List setPageToken(java.lang.String pageToken) { this.pageToken = pageToken; return this; } /** * If specified, return only messages with timestamps >= start_time. The default is the * job creation time (i.e. beginning of messages). */ @com.google.api.client.util.Key private java.lang.String startTime; /** If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages). */ public java.lang.String getStartTime() { return startTime; } /** * If specified, return only messages with timestamps >= start_time. The default is the * job creation time (i.e. beginning of messages). */ public List setStartTime(java.lang.String startTime) { this.startTime = startTime; return this; } /** * Return only messages with timestamps < end_time. The default is now (i.e. return up to * the latest messages available). */ @com.google.api.client.util.Key private java.lang.String endTime; /** Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available). */ public java.lang.String getEndTime() { return endTime; } /** * Return only messages with timestamps < end_time. The default is now (i.e. return up to * the latest messages available). */ public List setEndTime(java.lang.String endTime) { this.endTime = endTime; return this; } @Override public List set(String parameterName, Object value) { return (List) super.set(parameterName, value); } } } /** * An accessor for creating requests from the WorkItems collection. * *

The typical use is:

*
       *   {@code Dataflow dataflow = new Dataflow(...);}
       *   {@code Dataflow.WorkItems.List request = dataflow.workItems().list(parameters ...)}
       * 
* * @return the resource collection */ public WorkItems workItems() { return new WorkItems(); } /** * The "workItems" collection of methods. */ public class WorkItems { /** * Leases a dataflow WorkItem to run. * * Create a request for the method "workItems.lease". * * This request holds the parameters needed by the dataflow server. After setting any optional * parameters, call the {@link Lease#execute()} method to invoke the remote operation. * * @param projectId Identifies the project this worker belongs to. * @param jobId Identifies the workflow job this worker belongs to. * @param content the {@link com.google.api.services.dataflow.model.LeaseWorkItemRequest} * @return the request */ public Lease lease(java.lang.String projectId, java.lang.String jobId, com.google.api.services.dataflow.model.LeaseWorkItemRequest content) throws java.io.IOException { Lease result = new Lease(projectId, jobId, content); initialize(result); return result; } public class Lease extends DataflowRequest { private static final String REST_PATH = "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease"; /** * Leases a dataflow WorkItem to run. * * Create a request for the method "workItems.lease". * * This request holds the parameters needed by the the dataflow server. After setting any * optional parameters, call the {@link Lease#execute()} method to invoke the remote operation. *

{@link * Lease#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)} must * be called to initialize this instance immediately after invoking the constructor.

* * @param projectId Identifies the project this worker belongs to. * @param jobId Identifies the workflow job this worker belongs to. * @param content the {@link com.google.api.services.dataflow.model.LeaseWorkItemRequest} * @since 1.13 */ protected Lease(java.lang.String projectId, java.lang.String jobId, com.google.api.services.dataflow.model.LeaseWorkItemRequest content) { super(Dataflow.this, "POST", REST_PATH, content, com.google.api.services.dataflow.model.LeaseWorkItemResponse.class); this.projectId = com.google.api.client.util.Preconditions.checkNotNull(projectId, "Required parameter projectId must be specified."); this.jobId = com.google.api.client.util.Preconditions.checkNotNull(jobId, "Required parameter jobId must be specified."); } @Override public Lease set$Xgafv(java.lang.String $Xgafv) { return (Lease) super.set$Xgafv($Xgafv); } @Override public Lease setAccessToken(java.lang.String accessToken) { return (Lease) super.setAccessToken(accessToken); } @Override public Lease setAlt(java.lang.String alt) { return (Lease) super.setAlt(alt); } @Override public Lease setBearerToken(java.lang.String bearerToken) { return (Lease) super.setBearerToken(bearerToken); } @Override public Lease setCallback(java.lang.String callback) { return (Lease) super.setCallback(callback); } @Override public Lease setFields(java.lang.String fields) { return (Lease) super.setFields(fields); } @Override public Lease setKey(java.lang.String key) { return (Lease) super.setKey(key); } @Override public Lease setOauthToken(java.lang.String oauthToken) { return (Lease) super.setOauthToken(oauthToken); } @Override public Lease setPp(java.lang.Boolean pp) { return (Lease) super.setPp(pp); } @Override public Lease setPrettyPrint(java.lang.Boolean prettyPrint) { return (Lease) super.setPrettyPrint(prettyPrint); } @Override public Lease setQuotaUser(java.lang.String quotaUser) { return (Lease) super.setQuotaUser(quotaUser); } @Override public Lease setUploadType(java.lang.String uploadType) { return (Lease) super.setUploadType(uploadType); } @Override public Lease setUploadProtocol(java.lang.String uploadProtocol) { return (Lease) super.setUploadProtocol(uploadProtocol); } /** Identifies the project this worker belongs to. */ @com.google.api.client.util.Key private java.lang.String projectId; /** Identifies the project this worker belongs to. */ public java.lang.String getProjectId() { return projectId; } /** Identifies the project this worker belongs to. */ public Lease setProjectId(java.lang.String projectId) { this.projectId = projectId; return this; } /** Identifies the workflow job this worker belongs to. */ @com.google.api.client.util.Key private java.lang.String jobId; /** Identifies the workflow job this worker belongs to. */ public java.lang.String getJobId() { return jobId; } /** Identifies the workflow job this worker belongs to. */ public Lease setJobId(java.lang.String jobId) { this.jobId = jobId; return this; } @Override public Lease set(String parameterName, Object value) { return (Lease) super.set(parameterName, value); } } /** * Reports the status of dataflow WorkItems leased by a worker. * * Create a request for the method "workItems.reportStatus". * * This request holds the parameters needed by the dataflow server. After setting any optional * parameters, call the {@link ReportStatus#execute()} method to invoke the remote operation. * * @param projectId The project which owns the WorkItem's job. * @param jobId The job which the WorkItem is part of. * @param content the {@link com.google.api.services.dataflow.model.ReportWorkItemStatusRequest} * @return the request */ public ReportStatus reportStatus(java.lang.String projectId, java.lang.String jobId, com.google.api.services.dataflow.model.ReportWorkItemStatusRequest content) throws java.io.IOException { ReportStatus result = new ReportStatus(projectId, jobId, content); initialize(result); return result; } public class ReportStatus extends DataflowRequest { private static final String REST_PATH = "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus"; /** * Reports the status of dataflow WorkItems leased by a worker. * * Create a request for the method "workItems.reportStatus". * * This request holds the parameters needed by the the dataflow server. After setting any * optional parameters, call the {@link ReportStatus#execute()} method to invoke the remote * operation.

{@link * ReportStatus#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)} * must be called to initialize this instance immediately after invoking the constructor.

* * @param projectId The project which owns the WorkItem's job. * @param jobId The job which the WorkItem is part of. * @param content the {@link com.google.api.services.dataflow.model.ReportWorkItemStatusRequest} * @since 1.13 */ protected ReportStatus(java.lang.String projectId, java.lang.String jobId, com.google.api.services.dataflow.model.ReportWorkItemStatusRequest content) { super(Dataflow.this, "POST", REST_PATH, content, com.google.api.services.dataflow.model.ReportWorkItemStatusResponse.class); this.projectId = com.google.api.client.util.Preconditions.checkNotNull(projectId, "Required parameter projectId must be specified."); this.jobId = com.google.api.client.util.Preconditions.checkNotNull(jobId, "Required parameter jobId must be specified."); } @Override public ReportStatus set$Xgafv(java.lang.String $Xgafv) { return (ReportStatus) super.set$Xgafv($Xgafv); } @Override public ReportStatus setAccessToken(java.lang.String accessToken) { return (ReportStatus) super.setAccessToken(accessToken); } @Override public ReportStatus setAlt(java.lang.String alt) { return (ReportStatus) super.setAlt(alt); } @Override public ReportStatus setBearerToken(java.lang.String bearerToken) { return (ReportStatus) super.setBearerToken(bearerToken); } @Override public ReportStatus setCallback(java.lang.String callback) { return (ReportStatus) super.setCallback(callback); } @Override public ReportStatus setFields(java.lang.String fields) { return (ReportStatus) super.setFields(fields); } @Override public ReportStatus setKey(java.lang.String key) { return (ReportStatus) super.setKey(key); } @Override public ReportStatus setOauthToken(java.lang.String oauthToken) { return (ReportStatus) super.setOauthToken(oauthToken); } @Override public ReportStatus setPp(java.lang.Boolean pp) { return (ReportStatus) super.setPp(pp); } @Override public ReportStatus setPrettyPrint(java.lang.Boolean prettyPrint) { return (ReportStatus) super.setPrettyPrint(prettyPrint); } @Override public ReportStatus setQuotaUser(java.lang.String quotaUser) { return (ReportStatus) super.setQuotaUser(quotaUser); } @Override public ReportStatus setUploadType(java.lang.String uploadType) { return (ReportStatus) super.setUploadType(uploadType); } @Override public ReportStatus setUploadProtocol(java.lang.String uploadProtocol) { return (ReportStatus) super.setUploadProtocol(uploadProtocol); } /** The project which owns the WorkItem's job. */ @com.google.api.client.util.Key private java.lang.String projectId; /** The project which owns the WorkItem's job. */ public java.lang.String getProjectId() { return projectId; } /** The project which owns the WorkItem's job. */ public ReportStatus setProjectId(java.lang.String projectId) { this.projectId = projectId; return this; } /** The job which the WorkItem is part of. */ @com.google.api.client.util.Key private java.lang.String jobId; /** The job which the WorkItem is part of. */ public java.lang.String getJobId() { return jobId; } /** The job which the WorkItem is part of. */ public ReportStatus setJobId(java.lang.String jobId) { this.jobId = jobId; return this; } @Override public ReportStatus set(String parameterName, Object value) { return (ReportStatus) super.set(parameterName, value); } } } } } /** * Builder for {@link Dataflow}. * *

* Implementation is not thread-safe. *

* * @since 1.3.0 */ public static final class Builder extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient.Builder { /** * Returns an instance of a new builder. * * @param transport HTTP transport, which should normally be: *
    *
  • Google App Engine: * {@code com.google.api.client.extensions.appengine.http.UrlFetchTransport}
  • *
  • Android: {@code newCompatibleTransport} from * {@code com.google.api.client.extensions.android.http.AndroidHttp}
  • *
  • Java: {@link com.google.api.client.googleapis.javanet.GoogleNetHttpTransport#newTrustedTransport()} *
  • *
* @param jsonFactory JSON factory, which may be: *
    *
  • Jackson: {@code com.google.api.client.json.jackson2.JacksonFactory}
  • *
  • Google GSON: {@code com.google.api.client.json.gson.GsonFactory}
  • *
  • Android Honeycomb or higher: * {@code com.google.api.client.extensions.android.json.AndroidJsonFactory}
  • *
* @param httpRequestInitializer HTTP request initializer or {@code null} for none * @since 1.7 */ public Builder(com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory, com.google.api.client.http.HttpRequestInitializer httpRequestInitializer) { super( transport, jsonFactory, DEFAULT_ROOT_URL, DEFAULT_SERVICE_PATH, httpRequestInitializer, false); } /** Builds a new instance of {@link Dataflow}. */ @Override public Dataflow build() { return new Dataflow(this); } @Override public Builder setRootUrl(String rootUrl) { return (Builder) super.setRootUrl(rootUrl); } @Override public Builder setServicePath(String servicePath) { return (Builder) super.setServicePath(servicePath); } @Override public Builder setHttpRequestInitializer(com.google.api.client.http.HttpRequestInitializer httpRequestInitializer) { return (Builder) super.setHttpRequestInitializer(httpRequestInitializer); } @Override public Builder setApplicationName(String applicationName) { return (Builder) super.setApplicationName(applicationName); } @Override public Builder setSuppressPatternChecks(boolean suppressPatternChecks) { return (Builder) super.setSuppressPatternChecks(suppressPatternChecks); } @Override public Builder setSuppressRequiredParameterChecks(boolean suppressRequiredParameterChecks) { return (Builder) super.setSuppressRequiredParameterChecks(suppressRequiredParameterChecks); } @Override public Builder setSuppressAllChecks(boolean suppressAllChecks) { return (Builder) super.setSuppressAllChecks(suppressAllChecks); } /** * Set the {@link DataflowRequestInitializer}. * * @since 1.12 */ public Builder setDataflowRequestInitializer( DataflowRequestInitializer dataflowRequestInitializer) { return (Builder) super.setGoogleClientRequestInitializer(dataflowRequestInitializer); } @Override public Builder setGoogleClientRequestInitializer( com.google.api.client.googleapis.services.GoogleClientRequestInitializer googleClientRequestInitializer) { return (Builder) super.setGoogleClientRequestInitializer(googleClientRequestInitializer); } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy