com.google.api.services.script.Script Maven / Gradle / Ivy
/*
* 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: 2017-09-05 21:06:36 UTC)
* on 2017-09-20 at 20:13:34 UTC
* Modify at your own risk.
*/
package com.google.api.services.script;
/**
* Service definition for Script (v1).
*
*
* Executes functions in Google Apps Script projects.
*
*
*
* For more information about this service, see the
* API Documentation
*
*
*
* This service uses {@link ScriptRequestInitializer} to initialize global parameters via its
* {@link Builder}.
*
*
* @since 1.3
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public class Script 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 Apps Script Execution 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://script.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 Script(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
*/
Script(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 Scripts collection.
*
* The typical use is:
*
* {@code Script script = new Script(...);}
* {@code Script.Scripts.List request = script.scripts().list(parameters ...)}
*
*
* @return the resource collection
*/
public Scripts scripts() {
return new Scripts();
}
/**
* The "scripts" collection of methods.
*/
public class Scripts {
/**
* Runs a function in an Apps Script project. The project must be deployed for use with the Apps
* Script Execution API.
*
* This method requires authorization with an OAuth 2.0 token that includes at least one of the
* scopes listed in the [Authorization](#authorization) section; script projects that do not require
* authorization cannot be executed through this API. To find the correct scopes to include in the
* authentication token, open the project in the script editor, then select **File > Project
* properties** and click the **Scopes** tab.
*
* Create a request for the method "scripts.run".
*
* This request holds the parameters needed by the script server. After setting any optional
* parameters, call the {@link Run#execute()} method to invoke the remote operation.
*
* @param scriptId The script ID of the script to be executed. To find the script ID, open
the project in the script
* editor and select **File > Project properties**.
* @param content the {@link com.google.api.services.script.model.ExecutionRequest}
* @return the request
*/
public Run run(java.lang.String scriptId, com.google.api.services.script.model.ExecutionRequest content) throws java.io.IOException {
Run result = new Run(scriptId, content);
initialize(result);
return result;
}
public class Run extends ScriptRequest {
private static final String REST_PATH = "v1/scripts/{scriptId}:run";
/**
* Runs a function in an Apps Script project. The project must be deployed for use with the Apps
* Script Execution API.
*
* This method requires authorization with an OAuth 2.0 token that includes at least one of the
* scopes listed in the [Authorization](#authorization) section; script projects that do not
* require authorization cannot be executed through this API. To find the correct scopes to
* include in the authentication token, open the project in the script editor, then select **File
* > Project properties** and click the **Scopes** tab.
*
* Create a request for the method "scripts.run".
*
* This request holds the parameters needed by the the script server. After setting any optional
* parameters, call the {@link Run#execute()} method to invoke the remote operation. {@link
* Run#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)} must be
* called to initialize this instance immediately after invoking the constructor.
*
* @param scriptId The script ID of the script to be executed. To find the script ID, open
the project in the script
* editor and select **File > Project properties**.
* @param content the {@link com.google.api.services.script.model.ExecutionRequest}
* @since 1.13
*/
protected Run(java.lang.String scriptId, com.google.api.services.script.model.ExecutionRequest content) {
super(Script.this, "POST", REST_PATH, content, com.google.api.services.script.model.Operation.class);
this.scriptId = com.google.api.client.util.Preconditions.checkNotNull(scriptId, "Required parameter scriptId must be specified.");
}
@Override
public Run set$Xgafv(java.lang.String $Xgafv) {
return (Run) super.set$Xgafv($Xgafv);
}
@Override
public Run setAccessToken(java.lang.String accessToken) {
return (Run) super.setAccessToken(accessToken);
}
@Override
public Run setAlt(java.lang.String alt) {
return (Run) super.setAlt(alt);
}
@Override
public Run setBearerToken(java.lang.String bearerToken) {
return (Run) super.setBearerToken(bearerToken);
}
@Override
public Run setCallback(java.lang.String callback) {
return (Run) super.setCallback(callback);
}
@Override
public Run setFields(java.lang.String fields) {
return (Run) super.setFields(fields);
}
@Override
public Run setKey(java.lang.String key) {
return (Run) super.setKey(key);
}
@Override
public Run setOauthToken(java.lang.String oauthToken) {
return (Run) super.setOauthToken(oauthToken);
}
@Override
public Run setPp(java.lang.Boolean pp) {
return (Run) super.setPp(pp);
}
@Override
public Run setPrettyPrint(java.lang.Boolean prettyPrint) {
return (Run) super.setPrettyPrint(prettyPrint);
}
@Override
public Run setQuotaUser(java.lang.String quotaUser) {
return (Run) super.setQuotaUser(quotaUser);
}
@Override
public Run setUploadType(java.lang.String uploadType) {
return (Run) super.setUploadType(uploadType);
}
@Override
public Run setUploadProtocol(java.lang.String uploadProtocol) {
return (Run) super.setUploadProtocol(uploadProtocol);
}
/**
* The script ID of the script to be executed. To find the script ID, open the project in the
* script editor and select **File > Project properties**.
*/
@com.google.api.client.util.Key
private java.lang.String scriptId;
/** The script ID of the script to be executed. To find the script ID, open the project in the script
editor and select **File > Project properties**.
*/
public java.lang.String getScriptId() {
return scriptId;
}
/**
* The script ID of the script to be executed. To find the script ID, open the project in the
* script editor and select **File > Project properties**.
*/
public Run setScriptId(java.lang.String scriptId) {
this.scriptId = scriptId;
return this;
}
@Override
public Run set(String parameterName, Object value) {
return (Run) super.set(parameterName, value);
}
}
}
/**
* Builder for {@link Script}.
*
*
* 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 Script}. */
@Override
public Script build() {
return new Script(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 ScriptRequestInitializer}.
*
* @since 1.12
*/
public Builder setScriptRequestInitializer(
ScriptRequestInitializer scriptRequestInitializer) {
return (Builder) super.setGoogleClientRequestInitializer(scriptRequestInitializer);
}
@Override
public Builder setGoogleClientRequestInitializer(
com.google.api.client.googleapis.services.GoogleClientRequestInitializer googleClientRequestInitializer) {
return (Builder) super.setGoogleClientRequestInitializer(googleClientRequestInitializer);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy