blob: 2c9d44d81d7079ab4e60ae06c874a6ab6b36a053 [file] [log] [blame]
// This is a generated file (see the discoveryapis_generator project).
// ignore_for_file: unused_import, unnecessary_cast
library googleapis.cloudfunctions.v1;
import 'dart:core' as core;
import 'dart:async' as async;
import 'dart:convert' as convert;
import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;
export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
show ApiRequestError, DetailedApiRequestError;
const core.String USER_AGENT = 'dart-api-client cloudfunctions/v1';
/// Manages lightweight user-provided functions executed in response to events.
class CloudfunctionsApi {
/// View and manage your data across Google Cloud Platform services
static const CloudPlatformScope =
"https://www.googleapis.com/auth/cloud-platform";
final commons.ApiRequester _requester;
OperationsResourceApi get operations => new OperationsResourceApi(_requester);
ProjectsResourceApi get projects => new ProjectsResourceApi(_requester);
CloudfunctionsApi(http.Client client,
{core.String rootUrl = "https://cloudfunctions.googleapis.com/",
core.String servicePath = ""})
: _requester =
new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
}
class OperationsResourceApi {
final commons.ApiRequester _requester;
OperationsResourceApi(commons.ApiRequester client) : _requester = client;
/// Gets the latest state of a long-running operation. Clients can use this
/// method to poll the operation result at intervals as recommended by the API
/// service.
///
/// Request parameters:
///
/// [name] - The name of the operation resource.
/// Value must have pattern "^operations/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> get(core.String name, {core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
var _response = _requester.request(_url, "GET",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Operation.fromJson(data));
}
/// Lists operations that match the specified filter in the request. If the
/// server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the
/// `name` binding allows API services to override the binding to use
/// different resource name schemes, such as `users / * /operations`. To
/// override the binding, API services can add a binding such as
/// `"/v1/{name=users / * }/operations"` to their service configuration. For
/// backwards compatibility, the default name includes the operations
/// collection id, however overriding users must ensure the name binding is
/// the parent resource, without the operations collection id.
///
/// Request parameters:
///
/// [pageSize] - The maximum number of records that should be returned.
/// Requested page size cannot exceed 100. If not set, the default page size
/// is 100. Pagination is only supported when querying for a specific
/// function.
///
/// [filter] - Required. A filter for matching the requested operations. The
/// supported formats of *filter* are: To query for a specific function:
/// project:*,location:*,function:* To query for all of the latest operations
/// for a project: project:*,latest:true
///
/// [pageToken] - Token identifying which result to start with, which is
/// returned by a previous list call. Pagination is only supported when
/// querying for a specific function.
///
/// [name] - Must not be set.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListOperationsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListOperationsResponse> list(
{core.int pageSize,
core.String filter,
core.String pageToken,
core.String name,
core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (pageSize != null) {
_queryParams["pageSize"] = ["${pageSize}"];
}
if (filter != null) {
_queryParams["filter"] = [filter];
}
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
if (name != null) {
_queryParams["name"] = [name];
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v1/operations';
var _response = _requester.request(_url, "GET",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new ListOperationsResponse.fromJson(data));
}
}
class ProjectsResourceApi {
final commons.ApiRequester _requester;
ProjectsLocationsResourceApi get locations =>
new ProjectsLocationsResourceApi(_requester);
ProjectsResourceApi(commons.ApiRequester client) : _requester = client;
}
class ProjectsLocationsResourceApi {
final commons.ApiRequester _requester;
ProjectsLocationsFunctionsResourceApi get functions =>
new ProjectsLocationsFunctionsResourceApi(_requester);
ProjectsLocationsResourceApi(commons.ApiRequester client)
: _requester = client;
/// Lists information about the supported locations for this service.
///
/// Request parameters:
///
/// [name] - The resource that owns the locations collection, if applicable.
/// Value must have pattern "^projects/[^/]+$".
///
/// [pageSize] - The standard list page size.
///
/// [pageToken] - The standard list page token.
///
/// [filter] - The standard list filter.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListLocationsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListLocationsResponse> list(core.String name,
{core.int pageSize,
core.String pageToken,
core.String filter,
core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if (pageSize != null) {
_queryParams["pageSize"] = ["${pageSize}"];
}
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
if (filter != null) {
_queryParams["filter"] = [filter];
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url =
'v1/' + commons.Escaper.ecapeVariableReserved('$name') + '/locations';
var _response = _requester.request(_url, "GET",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new ListLocationsResponse.fromJson(data));
}
}
class ProjectsLocationsFunctionsResourceApi {
final commons.ApiRequester _requester;
ProjectsLocationsFunctionsResourceApi(commons.ApiRequester client)
: _requester = client;
/// Synchronously invokes a deployed Cloud Function. To be used for testing
/// purposes as very limited traffic is allowed. For more information on the
/// actual limits, refer to [Rate
/// Limits](https://cloud.google.com/functions/quotas#rate_limits).
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. The name of the function to be called.
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/functions/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [CallFunctionResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<CallFunctionResponse> call(
CallFunctionRequest request, core.String name,
{core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (request != null) {
_body = convert.json.encode((request).toJson());
}
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':call';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new CallFunctionResponse.fromJson(data));
}
/// Creates a new function. If a function with the given name already exists
/// in the specified project, the long running operation will return
/// `ALREADY_EXISTS` error.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [location] - Required. The project and location in which the function
/// should be created, specified in the format `projects / * /locations / * `
/// Value must have pattern "^projects/[^/]+/locations/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> create(CloudFunction request, core.String location,
{core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (request != null) {
_body = convert.json.encode((request).toJson());
}
if (location == null) {
throw new core.ArgumentError("Parameter location is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$location') +
'/functions';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Operation.fromJson(data));
}
/// Deletes a function with the given name from the specified project. If the
/// given function is used by some trigger, the trigger will be updated to
/// remove this function.
///
/// Request parameters:
///
/// [name] - Required. The name of the function which should be deleted.
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/functions/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> delete(core.String name, {core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
var _response = _requester.request(_url, "DELETE",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Operation.fromJson(data));
}
/// Returns a signed URL for downloading deployed function source code. The
/// URL is only valid for a limited period and should be used within minutes
/// after generation. For more information about the signed URL usage see:
/// https://cloud.google.com/storage/docs/access-control/signed-urls
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - The name of function for which source code Google Cloud Storage
/// signed URL should be generated.
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/functions/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GenerateDownloadUrlResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GenerateDownloadUrlResponse> generateDownloadUrl(
GenerateDownloadUrlRequest request, core.String name,
{core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (request != null) {
_body = convert.json.encode((request).toJson());
}
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$name') +
':generateDownloadUrl';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response
.then((data) => new GenerateDownloadUrlResponse.fromJson(data));
}
/// Returns a signed URL for uploading a function source code. For more
/// information about the signed URL usage see:
/// https://cloud.google.com/storage/docs/access-control/signed-urls. Once the
/// function source code upload is complete, the used signed URL should be
/// provided in CreateFunction or UpdateFunction request as a reference to the
/// function source code. When uploading source code to the generated signed
/// URL, please follow these restrictions: * Source file type should be a zip
/// file. * Source file size should not exceed 100MB limit. * No credentials
/// should be attached - the signed URLs provide access to the target bucket
/// using internal service identity; if credentials were attached, the
/// identity from the credentials would be used, but that identity does not
/// have permissions to upload files to the URL. When making a HTTP PUT
/// request, these two headers need to be specified: * `content-type:
/// application/zip` * `x-goog-content-length-range: 0,104857600` And this
/// header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN`
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - The project and location in which the Google Cloud Storage
/// signed URL should be generated, specified in the format `projects / *
/// /locations / * `.
/// Value must have pattern "^projects/[^/]+/locations/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GenerateUploadUrlResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GenerateUploadUrlResponse> generateUploadUrl(
GenerateUploadUrlRequest request, core.String parent,
{core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (request != null) {
_body = convert.json.encode((request).toJson());
}
if (parent == null) {
throw new core.ArgumentError("Parameter parent is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/functions:generateUploadUrl';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response
.then((data) => new GenerateUploadUrlResponse.fromJson(data));
}
/// Returns a function with the given name from the requested project.
///
/// Request parameters:
///
/// [name] - Required. The name of the function which details should be
/// obtained.
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/functions/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [CloudFunction].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<CloudFunction> get(core.String name, {core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
var _response = _requester.request(_url, "GET",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new CloudFunction.fromJson(data));
}
/// Gets the IAM access control policy for a function. Returns an empty policy
/// if the function exists and does not have a policy set.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/functions/[^/]+$".
///
/// [options_requestedPolicyVersion] - Optional. The policy format version to
/// be returned. Valid values are 0, 1, and 3. Requests specifying an invalid
/// value will be rejected. Requests for policies with any conditional
/// bindings must specify version 3. Policies without any conditional bindings
/// may specify any valid value or leave the field unset. To learn which
/// resources support conditions in their IAM policies, see the [IAM
/// documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> getIamPolicy(core.String resource,
{core.int options_requestedPolicyVersion, core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (resource == null) {
throw new core.ArgumentError("Parameter resource is required.");
}
if (options_requestedPolicyVersion != null) {
_queryParams["options.requestedPolicyVersion"] = [
"${options_requestedPolicyVersion}"
];
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':getIamPolicy';
var _response = _requester.request(_url, "GET",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Policy.fromJson(data));
}
/// Returns a list of functions that belong to the requested project.
///
/// Request parameters:
///
/// [parent] - The project and location from which the function should be
/// listed, specified in the format `projects / * /locations / * ` If you want
/// to list functions in all locations, use "-" in place of a location. When
/// listing functions in all locations, if one or more location(s) are
/// unreachable, the response will contain functions from all reachable
/// locations along with the names of any unreachable locations.
/// Value must have pattern "^projects/[^/]+/locations/[^/]+$".
///
/// [pageSize] - Maximum number of functions to return per call.
///
/// [pageToken] - The value returned by the last `ListFunctionsResponse`;
/// indicates that this is a continuation of a prior `ListFunctions` call, and
/// that the system should return the next page of data.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListFunctionsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListFunctionsResponse> list(core.String parent,
{core.int pageSize, core.String pageToken, core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (parent == null) {
throw new core.ArgumentError("Parameter parent is required.");
}
if (pageSize != null) {
_queryParams["pageSize"] = ["${pageSize}"];
}
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url =
'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/functions';
var _response = _requester.request(_url, "GET",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new ListFunctionsResponse.fromJson(data));
}
/// Updates existing function.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - A user-defined name of the function. Function names must be
/// unique globally and match pattern `projects / * /locations / * /functions
/// / * `
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/functions/[^/]+$".
///
/// [updateMask] - Required list of fields to be updated in this request.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> patch(CloudFunction request, core.String name,
{core.String updateMask, core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (request != null) {
_body = convert.json.encode((request).toJson());
}
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if (updateMask != null) {
_queryParams["updateMask"] = [updateMask];
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
var _response = _requester.request(_url, "PATCH",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Operation.fromJson(data));
}
/// Sets the IAM access control policy on the specified function. Replaces any
/// existing policy.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// specified. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/functions/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> setIamPolicy(
SetIamPolicyRequest request, core.String resource,
{core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (request != null) {
_body = convert.json.encode((request).toJson());
}
if (resource == null) {
throw new core.ArgumentError("Parameter resource is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':setIamPolicy';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Policy.fromJson(data));
}
/// Tests the specified permissions against the IAM access control policy for
/// a function. If the function does not exist, this will return an empty set
/// of permissions, not a NOT_FOUND error.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy detail is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/functions/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [TestIamPermissionsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<TestIamPermissionsResponse> testIamPermissions(
TestIamPermissionsRequest request, core.String resource,
{core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (request != null) {
_body = convert.json.encode((request).toJson());
}
if (resource == null) {
throw new core.ArgumentError("Parameter resource is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':testIamPermissions';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response
.then((data) => new TestIamPermissionsResponse.fromJson(data));
}
}
/// Specifies the audit configuration for a service. The configuration
/// determines which permission types are logged, and what identities, if any,
/// are exempted from logging. An AuditConfig must have one or more
/// AuditLogConfigs. If there are AuditConfigs for both `allServices` and a
/// specific service, the union of the two AuditConfigs is used for that
/// service: the log_types specified in each AuditConfig are enabled, and the
/// exempted_members in each AuditLogConfig are exempted. Example Policy with
/// multiple AuditConfigs: { "audit_configs": [ { "service": "allServices",
/// "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [
/// "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type":
/// "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com",
/// "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type":
/// "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For
/// sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
/// logging. It also exempts jose@example.com from DATA_READ logging, and
/// aliya@example.com from DATA_WRITE logging.
class AuditConfig {
/// The configuration for logging of each type of permission.
core.List<AuditLogConfig> auditLogConfigs;
/// Specifies a service that will be enabled for audit logging. For example,
/// `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a
/// special value that covers all services.
core.String service;
AuditConfig();
AuditConfig.fromJson(core.Map _json) {
if (_json.containsKey("auditLogConfigs")) {
auditLogConfigs = (_json["auditLogConfigs"] as core.List)
.map<AuditLogConfig>((value) => new AuditLogConfig.fromJson(value))
.toList();
}
if (_json.containsKey("service")) {
service = _json["service"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (auditLogConfigs != null) {
_json["auditLogConfigs"] =
auditLogConfigs.map((value) => (value).toJson()).toList();
}
if (service != null) {
_json["service"] = service;
}
return _json;
}
}
/// Provides the configuration for logging a type of permissions. Example: {
/// "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [
/// "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables
/// 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from
/// DATA_READ logging.
class AuditLogConfig {
/// Specifies the identities that do not cause logging for this type of
/// permission. Follows the same format of Binding.members.
core.List<core.String> exemptedMembers;
/// The log type that this config enables.
/// Possible string values are:
/// - "LOG_TYPE_UNSPECIFIED" : Default case. Should never be this.
/// - "ADMIN_READ" : Admin reads. Example: CloudIAM getIamPolicy
/// - "DATA_WRITE" : Data writes. Example: CloudSQL Users create
/// - "DATA_READ" : Data reads. Example: CloudSQL Users list
core.String logType;
AuditLogConfig();
AuditLogConfig.fromJson(core.Map _json) {
if (_json.containsKey("exemptedMembers")) {
exemptedMembers =
(_json["exemptedMembers"] as core.List).cast<core.String>();
}
if (_json.containsKey("logType")) {
logType = _json["logType"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (exemptedMembers != null) {
_json["exemptedMembers"] = exemptedMembers;
}
if (logType != null) {
_json["logType"] = logType;
}
return _json;
}
}
/// Associates `members` with a `role`.
class Binding {
/// The condition that is associated with this binding. If the condition
/// evaluates to `true`, then this binding applies to the current request. If
/// the condition evaluates to `false`, then this binding does not apply to
/// the current request. However, a different role binding might grant the
/// same role to one or more of the members in this binding. To learn which
/// resources support conditions in their IAM policies, see the [IAM
/// documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Expr condition;
/// Specifies the identities requesting access for a Cloud Platform resource.
/// `members` can have the following values: * `allUsers`: A special
/// identifier that represents anyone who is on the internet; with or without
/// a Google account. * `allAuthenticatedUsers`: A special identifier that
/// represents anyone who is authenticated with a Google account or a service
/// account. * `user:{emailid}`: An email address that represents a specific
/// Google account. For example, `alice@example.com` . *
/// `serviceAccount:{emailid}`: An email address that represents a service
/// account. For example, `my-other-app@appspot.gserviceaccount.com`. *
/// `group:{emailid}`: An email address that represents a Google group. For
/// example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`:
/// An email address (plus unique identifier) representing a user that has
/// been recently deleted. For example,
/// `alice@example.com?uid=123456789012345678901`. If the user is recovered,
/// this value reverts to `user:{emailid}` and the recovered user retains the
/// role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`:
/// An email address (plus unique identifier) representing a service account
/// that has been recently deleted. For example,
/// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If
/// the service account is undeleted, this value reverts to
/// `serviceAccount:{emailid}` and the undeleted service account retains the
/// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email
/// address (plus unique identifier) representing a Google group that has been
/// recently deleted. For example,
/// `admins@example.com?uid=123456789012345678901`. If the group is recovered,
/// this value reverts to `group:{emailid}` and the recovered group retains
/// the role in the binding. * `domain:{domain}`: The G Suite domain (primary)
/// that represents all the users of that domain. For example, `google.com` or
/// `example.com`.
core.List<core.String> members;
/// Role that is assigned to `members`. For example, `roles/viewer`,
/// `roles/editor`, or `roles/owner`.
core.String role;
Binding();
Binding.fromJson(core.Map _json) {
if (_json.containsKey("condition")) {
condition = new Expr.fromJson(_json["condition"]);
}
if (_json.containsKey("members")) {
members = (_json["members"] as core.List).cast<core.String>();
}
if (_json.containsKey("role")) {
role = _json["role"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (condition != null) {
_json["condition"] = (condition).toJson();
}
if (members != null) {
_json["members"] = members;
}
if (role != null) {
_json["role"] = role;
}
return _json;
}
}
/// Request for the `CallFunction` method.
class CallFunctionRequest {
/// Required. Input to be passed to the function.
core.String data;
CallFunctionRequest();
CallFunctionRequest.fromJson(core.Map _json) {
if (_json.containsKey("data")) {
data = _json["data"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (data != null) {
_json["data"] = data;
}
return _json;
}
}
/// Response of `CallFunction` method.
class CallFunctionResponse {
/// Either system or user-function generated error. Set if execution was not
/// successful.
core.String error;
/// Execution id of function invocation.
core.String executionId;
/// Result populated for successful execution of synchronous function. Will
/// not be populated if function does not return a result through context.
core.String result;
CallFunctionResponse();
CallFunctionResponse.fromJson(core.Map _json) {
if (_json.containsKey("error")) {
error = _json["error"];
}
if (_json.containsKey("executionId")) {
executionId = _json["executionId"];
}
if (_json.containsKey("result")) {
result = _json["result"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (error != null) {
_json["error"] = error;
}
if (executionId != null) {
_json["executionId"] = executionId;
}
if (result != null) {
_json["result"] = result;
}
return _json;
}
}
/// Describes a Cloud Function that contains user computation executed in
/// response to an event. It encapsulate function and triggers configurations.
class CloudFunction {
/// The amount of memory in MB available for a function. Defaults to 256MB.
core.int availableMemoryMb;
/// Build environment variables that shall be available during build time.
core.Map<core.String, core.String> buildEnvironmentVariables;
/// Output only. The Cloud Build ID of the latest successful deployment of the
/// function.
core.String buildId;
/// User-provided description of a function.
core.String description;
/// The name of the function (as defined in source code) that will be
/// executed. Defaults to the resource name suffix, if not specified. For
/// backward compatibility, if function with given name is not found, then the
/// system will try to use function named "function". For Node.js this is name
/// of a function exported by the module specified in `source_location`.
core.String entryPoint;
/// Environment variables that shall be available during function execution.
core.Map<core.String, core.String> environmentVariables;
/// A source that fires events in response to a condition in another service.
EventTrigger eventTrigger;
/// An HTTPS endpoint type of source that can be triggered via URL.
HttpsTrigger httpsTrigger;
/// The ingress settings for the function, controlling what traffic can reach
/// it.
/// Possible string values are:
/// - "INGRESS_SETTINGS_UNSPECIFIED" : Unspecified.
/// - "ALLOW_ALL" : Allow HTTP traffic from public and private sources.
/// - "ALLOW_INTERNAL_ONLY" : Allow HTTP traffic from only private VPC
/// sources.
/// - "ALLOW_INTERNAL_AND_GCLB" : Allow HTTP traffic from private VPC sources
/// and through GCLB.
core.String ingressSettings;
/// Labels associated with this Cloud Function.
core.Map<core.String, core.String> labels;
/// The limit on the maximum number of function instances that may coexist at
/// a given time. In some cases, such as rapid traffic surges, Cloud Functions
/// may, for a short period of time, create more instances than the specified
/// max instances limit. If your function cannot tolerate this temporary
/// behavior, you may want to factor in a safety margin and set a lower max
/// instances value than your function can tolerate. See the [Max
/// Instances](https://cloud.google.com/functions/docs/max-instances) Guide
/// for more details.
core.int maxInstances;
/// A user-defined name of the function. Function names must be unique
/// globally and match pattern `projects / * /locations / * /functions / * `
core.String name;
/// The VPC Network that this cloud function can connect to. It can be either
/// the fully-qualified URI, or the short name of the network resource. If the
/// short network name is used, the network must belong to the same project.
/// Otherwise, it must belong to a project within the same organization. The
/// format of this field is either
/// `projects/{project}/global/networks/{network}` or `{network}`, where
/// {project} is a project id where the network is defined, and {network} is
/// the short name of the network. This field is mutually exclusive with
/// `vpc_connector` and will be replaced by it. See [the VPC
/// documentation](https://cloud.google.com/compute/docs/vpc) for more
/// information on connecting Cloud projects.
core.String network;
/// The runtime in which to run the function. Required when deploying a new
/// function, optional when updating an existing function. For a complete list
/// of possible choices, see the [`gcloud` command
/// reference](/sdk/gcloud/reference/functions/deploy#--runtime).
core.String runtime;
/// The email of the function's service account. If empty, defaults to
/// `{project_id}@appspot.gserviceaccount.com`.
core.String serviceAccountEmail;
/// The Google Cloud Storage URL, starting with gs://, pointing to the zip
/// archive which contains the function.
core.String sourceArchiveUrl;
/// **Beta Feature** The source repository where a function is hosted.
SourceRepository sourceRepository;
/// The Google Cloud Storage signed URL used for source uploading, generated
/// by google.cloud.functions.v1.GenerateUploadUrl
core.String sourceUploadUrl;
/// Output only. Status of the function deployment.
/// Possible string values are:
/// - "CLOUD_FUNCTION_STATUS_UNSPECIFIED" : Not specified. Invalid state.
/// - "ACTIVE" : Function has been successfully deployed and is serving.
/// - "OFFLINE" : Function deployment failed and the function isn’t serving.
/// - "DEPLOY_IN_PROGRESS" : Function is being created or updated.
/// - "DELETE_IN_PROGRESS" : Function is being deleted.
/// - "UNKNOWN" : Function deployment failed and the function serving state is
/// undefined. The function should be updated or deleted to move it out of
/// this state.
core.String status;
/// The function execution timeout. Execution is considered failed and can be
/// terminated if the function is not completed at the end of the timeout
/// period. Defaults to 60 seconds.
core.String timeout;
/// Output only. The last update timestamp of a Cloud Function.
core.String updateTime;
/// Output only. The version identifier of the Cloud Function. Each deployment
/// attempt results in a new version of a function being created.
core.String versionId;
/// The VPC Network Connector that this cloud function can connect to. It can
/// be either the fully-qualified URI, or the short name of the network
/// connector resource. The format of this field is `projects / * /locations /
/// * /connectors / * ` This field is mutually exclusive with `network` field
/// and will eventually replace it. See [the VPC
/// documentation](https://cloud.google.com/compute/docs/vpc) for more
/// information on connecting Cloud projects.
core.String vpcConnector;
/// The egress settings for the connector, controlling what traffic is
/// diverted through it.
/// Possible string values are:
/// - "VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED" : Unspecified.
/// - "PRIVATE_RANGES_ONLY" : Use the VPC Access Connector only for private IP
/// space from RFC1918.
/// - "ALL_TRAFFIC" : Force the use of VPC Access Connector for all egress
/// traffic from the function.
core.String vpcConnectorEgressSettings;
CloudFunction();
CloudFunction.fromJson(core.Map _json) {
if (_json.containsKey("availableMemoryMb")) {
availableMemoryMb = _json["availableMemoryMb"];
}
if (_json.containsKey("buildEnvironmentVariables")) {
buildEnvironmentVariables =
(_json["buildEnvironmentVariables"] as core.Map)
.cast<core.String, core.String>();
}
if (_json.containsKey("buildId")) {
buildId = _json["buildId"];
}
if (_json.containsKey("description")) {
description = _json["description"];
}
if (_json.containsKey("entryPoint")) {
entryPoint = _json["entryPoint"];
}
if (_json.containsKey("environmentVariables")) {
environmentVariables = (_json["environmentVariables"] as core.Map)
.cast<core.String, core.String>();
}
if (_json.containsKey("eventTrigger")) {
eventTrigger = new EventTrigger.fromJson(_json["eventTrigger"]);
}
if (_json.containsKey("httpsTrigger")) {
httpsTrigger = new HttpsTrigger.fromJson(_json["httpsTrigger"]);
}
if (_json.containsKey("ingressSettings")) {
ingressSettings = _json["ingressSettings"];
}
if (_json.containsKey("labels")) {
labels = (_json["labels"] as core.Map).cast<core.String, core.String>();
}
if (_json.containsKey("maxInstances")) {
maxInstances = _json["maxInstances"];
}
if (_json.containsKey("name")) {
name = _json["name"];
}
if (_json.containsKey("network")) {
network = _json["network"];
}
if (_json.containsKey("runtime")) {
runtime = _json["runtime"];
}
if (_json.containsKey("serviceAccountEmail")) {
serviceAccountEmail = _json["serviceAccountEmail"];
}
if (_json.containsKey("sourceArchiveUrl")) {
sourceArchiveUrl = _json["sourceArchiveUrl"];
}
if (_json.containsKey("sourceRepository")) {
sourceRepository =
new SourceRepository.fromJson(_json["sourceRepository"]);
}
if (_json.containsKey("sourceUploadUrl")) {
sourceUploadUrl = _json["sourceUploadUrl"];
}
if (_json.containsKey("status")) {
status = _json["status"];
}
if (_json.containsKey("timeout")) {
timeout = _json["timeout"];
}
if (_json.containsKey("updateTime")) {
updateTime = _json["updateTime"];
}
if (_json.containsKey("versionId")) {
versionId = _json["versionId"];
}
if (_json.containsKey("vpcConnector")) {
vpcConnector = _json["vpcConnector"];
}
if (_json.containsKey("vpcConnectorEgressSettings")) {
vpcConnectorEgressSettings = _json["vpcConnectorEgressSettings"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (availableMemoryMb != null) {
_json["availableMemoryMb"] = availableMemoryMb;
}
if (buildEnvironmentVariables != null) {
_json["buildEnvironmentVariables"] = buildEnvironmentVariables;
}
if (buildId != null) {
_json["buildId"] = buildId;
}
if (description != null) {
_json["description"] = description;
}
if (entryPoint != null) {
_json["entryPoint"] = entryPoint;
}
if (environmentVariables != null) {
_json["environmentVariables"] = environmentVariables;
}
if (eventTrigger != null) {
_json["eventTrigger"] = (eventTrigger).toJson();
}
if (httpsTrigger != null) {
_json["httpsTrigger"] = (httpsTrigger).toJson();
}
if (ingressSettings != null) {
_json["ingressSettings"] = ingressSettings;
}
if (labels != null) {
_json["labels"] = labels;
}
if (maxInstances != null) {
_json["maxInstances"] = maxInstances;
}
if (name != null) {
_json["name"] = name;
}
if (network != null) {
_json["network"] = network;
}
if (runtime != null) {
_json["runtime"] = runtime;
}
if (serviceAccountEmail != null) {
_json["serviceAccountEmail"] = serviceAccountEmail;
}
if (sourceArchiveUrl != null) {
_json["sourceArchiveUrl"] = sourceArchiveUrl;
}
if (sourceRepository != null) {
_json["sourceRepository"] = (sourceRepository).toJson();
}
if (sourceUploadUrl != null) {
_json["sourceUploadUrl"] = sourceUploadUrl;
}
if (status != null) {
_json["status"] = status;
}
if (timeout != null) {
_json["timeout"] = timeout;
}
if (updateTime != null) {
_json["updateTime"] = updateTime;
}
if (versionId != null) {
_json["versionId"] = versionId;
}
if (vpcConnector != null) {
_json["vpcConnector"] = vpcConnector;
}
if (vpcConnectorEgressSettings != null) {
_json["vpcConnectorEgressSettings"] = vpcConnectorEgressSettings;
}
return _json;
}
}
/// Describes EventTrigger, used to request events be sent from another service.
class EventTrigger {
/// Required. The type of event to observe. For example:
/// `providers/cloud.storage/eventTypes/object.change` and
/// `providers/cloud.pubsub/eventTypes/topic.publish`. Event types match
/// pattern `providers / * /eventTypes / * .*`. The pattern contains: 1.
/// namespace: For example, `cloud.storage` and `google.firebase.analytics`.
/// 2. resource type: The type of resource on which event occurs. For example,
/// the Google Cloud Storage API includes the type `object`. 3. action: The
/// action that generates the event. For example, action for a Google Cloud
/// Storage Object is 'change'. These parts are lower case.
core.String eventType;
/// Specifies policy for failed executions.
FailurePolicy failurePolicy;
/// Required. The resource(s) from which to observe events, for example,
/// `projects/_/buckets/myBucket`. Not all syntactically correct values are
/// accepted by all services. For example: 1. The authorization model must
/// support it. Google Cloud Functions only allows EventTriggers to be
/// deployed that observe resources in the same project as the
/// `CloudFunction`. 2. The resource type must match the pattern expected for
/// an `event_type`. For example, an `EventTrigger` that has an `event_type`
/// of "google.pubsub.topic.publish" should have a resource that matches
/// Google Cloud Pub/Sub topics. Additionally, some services may support short
/// names when creating an `EventTrigger`. These will always be returned in
/// the normalized "long" format. See each *service's* documentation for
/// supported formats.
core.String resource;
/// The hostname of the service that should be observed. If no string is
/// provided, the default service implementing the API will be used. For
/// example, `storage.googleapis.com` is the default for all event types in
/// the `google.storage` namespace.
core.String service;
EventTrigger();
EventTrigger.fromJson(core.Map _json) {
if (_json.containsKey("eventType")) {
eventType = _json["eventType"];
}
if (_json.containsKey("failurePolicy")) {
failurePolicy = new FailurePolicy.fromJson(_json["failurePolicy"]);
}
if (_json.containsKey("resource")) {
resource = _json["resource"];
}
if (_json.containsKey("service")) {
service = _json["service"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (eventType != null) {
_json["eventType"] = eventType;
}
if (failurePolicy != null) {
_json["failurePolicy"] = (failurePolicy).toJson();
}
if (resource != null) {
_json["resource"] = resource;
}
if (service != null) {
_json["service"] = service;
}
return _json;
}
}
/// Represents a textual expression in the Common Expression Language (CEL)
/// syntax. CEL is a C-like expression language. The syntax and semantics of CEL
/// are documented at https://github.com/google/cel-spec. Example (Comparison):
/// title: "Summary size limit" description: "Determines if a summary is less
/// than 100 chars" expression: "document.summary.size() < 100" Example
/// (Equality): title: "Requestor is owner" description: "Determines if
/// requestor is the document owner" expression: "document.owner ==
/// request.auth.claims.email" Example (Logic): title: "Public documents"
/// description: "Determine whether the document should be publicly visible"
/// expression: "document.type != 'private' && document.type != 'internal'"
/// Example (Data Manipulation): title: "Notification string" description:
/// "Create a notification string with a timestamp." expression: "'New message
/// received at ' + string(document.create_time)" The exact variables and
/// functions that may be referenced within an expression are determined by the
/// service that evaluates it. See the service documentation for additional
/// information.
class Expr {
/// Optional. Description of the expression. This is a longer text which
/// describes the expression, e.g. when hovered over it in a UI.
core.String description;
/// Textual representation of an expression in Common Expression Language
/// syntax.
core.String expression;
/// Optional. String indicating the location of the expression for error
/// reporting, e.g. a file name and a position in the file.
core.String location;
/// Optional. Title for the expression, i.e. a short string describing its
/// purpose. This can be used e.g. in UIs which allow to enter the expression.
core.String title;
Expr();
Expr.fromJson(core.Map _json) {
if (_json.containsKey("description")) {
description = _json["description"];
}
if (_json.containsKey("expression")) {
expression = _json["expression"];
}
if (_json.containsKey("location")) {
location = _json["location"];
}
if (_json.containsKey("title")) {
title = _json["title"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (description != null) {
_json["description"] = description;
}
if (expression != null) {
_json["expression"] = expression;
}
if (location != null) {
_json["location"] = location;
}
if (title != null) {
_json["title"] = title;
}
return _json;
}
}
/// Describes the policy in case of function's execution failure. If empty, then
/// defaults to ignoring failures (i.e. not retrying them).
class FailurePolicy {
/// If specified, then the function will be retried in case of a failure.
Retry retry;
FailurePolicy();
FailurePolicy.fromJson(core.Map _json) {
if (_json.containsKey("retry")) {
retry = new Retry.fromJson(_json["retry"]);
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (retry != null) {
_json["retry"] = (retry).toJson();
}
return _json;
}
}
/// Request of `GenerateDownloadUrl` method.
class GenerateDownloadUrlRequest {
/// The optional version of function. If not set, default, current version is
/// used.
core.String versionId;
GenerateDownloadUrlRequest();
GenerateDownloadUrlRequest.fromJson(core.Map _json) {
if (_json.containsKey("versionId")) {
versionId = _json["versionId"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (versionId != null) {
_json["versionId"] = versionId;
}
return _json;
}
}
/// Response of `GenerateDownloadUrl` method.
class GenerateDownloadUrlResponse {
/// The generated Google Cloud Storage signed URL that should be used for
/// function source code download.
core.String downloadUrl;
GenerateDownloadUrlResponse();
GenerateDownloadUrlResponse.fromJson(core.Map _json) {
if (_json.containsKey("downloadUrl")) {
downloadUrl = _json["downloadUrl"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (downloadUrl != null) {
_json["downloadUrl"] = downloadUrl;
}
return _json;
}
}
/// Request of `GenerateSourceUploadUrl` method.
class GenerateUploadUrlRequest {
GenerateUploadUrlRequest();
GenerateUploadUrlRequest.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
return _json;
}
}
/// Response of `GenerateSourceUploadUrl` method.
class GenerateUploadUrlResponse {
/// The generated Google Cloud Storage signed URL that should be used for a
/// function source code upload. The uploaded file should be a zip archive
/// which contains a function.
core.String uploadUrl;
GenerateUploadUrlResponse();
GenerateUploadUrlResponse.fromJson(core.Map _json) {
if (_json.containsKey("uploadUrl")) {
uploadUrl = _json["uploadUrl"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (uploadUrl != null) {
_json["uploadUrl"] = uploadUrl;
}
return _json;
}
}
/// Describes HttpsTrigger, could be used to connect web hooks to function.
class HttpsTrigger {
/// Output only. The deployed url for the function.
core.String url;
HttpsTrigger();
HttpsTrigger.fromJson(core.Map _json) {
if (_json.containsKey("url")) {
url = _json["url"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (url != null) {
_json["url"] = url;
}
return _json;
}
}
/// Response for the `ListFunctions` method.
class ListFunctionsResponse {
/// The functions that match the request.
core.List<CloudFunction> functions;
/// If not empty, indicates that there may be more functions that match the
/// request; this value should be passed in a new
/// google.cloud.functions.v1.ListFunctionsRequest to get more functions.
core.String nextPageToken;
/// Locations that could not be reached. The response does not include any
/// functions from these locations.
core.List<core.String> unreachable;
ListFunctionsResponse();
ListFunctionsResponse.fromJson(core.Map _json) {
if (_json.containsKey("functions")) {
functions = (_json["functions"] as core.List)
.map<CloudFunction>((value) => new CloudFunction.fromJson(value))
.toList();
}
if (_json.containsKey("nextPageToken")) {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("unreachable")) {
unreachable = (_json["unreachable"] as core.List).cast<core.String>();
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (functions != null) {
_json["functions"] = functions.map((value) => (value).toJson()).toList();
}
if (nextPageToken != null) {
_json["nextPageToken"] = nextPageToken;
}
if (unreachable != null) {
_json["unreachable"] = unreachable;
}
return _json;
}
}
/// The response message for Locations.ListLocations.
class ListLocationsResponse {
/// A list of locations that matches the specified filter in the request.
core.List<Location> locations;
/// The standard List next-page token.
core.String nextPageToken;
ListLocationsResponse();
ListLocationsResponse.fromJson(core.Map _json) {
if (_json.containsKey("locations")) {
locations = (_json["locations"] as core.List)
.map<Location>((value) => new Location.fromJson(value))
.toList();
}
if (_json.containsKey("nextPageToken")) {
nextPageToken = _json["nextPageToken"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (locations != null) {
_json["locations"] = locations.map((value) => (value).toJson()).toList();
}
if (nextPageToken != null) {
_json["nextPageToken"] = nextPageToken;
}
return _json;
}
}
/// The response message for Operations.ListOperations.
class ListOperationsResponse {
/// The standard List next-page token.
core.String nextPageToken;
/// A list of operations that matches the specified filter in the request.
core.List<Operation> operations;
ListOperationsResponse();
ListOperationsResponse.fromJson(core.Map _json) {
if (_json.containsKey("nextPageToken")) {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("operations")) {
operations = (_json["operations"] as core.List)
.map<Operation>((value) => new Operation.fromJson(value))
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (nextPageToken != null) {
_json["nextPageToken"] = nextPageToken;
}
if (operations != null) {
_json["operations"] =
operations.map((value) => (value).toJson()).toList();
}
return _json;
}
}
/// A resource that represents Google Cloud Platform location.
class Location {
/// The friendly name for this location, typically a nearby city name. For
/// example, "Tokyo".
core.String displayName;
/// Cross-service attributes for the location. For example
/// {"cloud.googleapis.com/region": "us-east1"}
core.Map<core.String, core.String> labels;
/// The canonical id for this location. For example: `"us-east1"`.
core.String locationId;
/// Service-specific metadata. For example the available capacity at the given
/// location.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> metadata;
/// Resource name for the location, which may vary between implementations.
/// For example: `"projects/example-project/locations/us-east1"`
core.String name;
Location();
Location.fromJson(core.Map _json) {
if (_json.containsKey("displayName")) {
displayName = _json["displayName"];
}
if (_json.containsKey("labels")) {
labels = (_json["labels"] as core.Map).cast<core.String, core.String>();
}
if (_json.containsKey("locationId")) {
locationId = _json["locationId"];
}
if (_json.containsKey("metadata")) {
metadata =
(_json["metadata"] as core.Map).cast<core.String, core.Object>();
}
if (_json.containsKey("name")) {
name = _json["name"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (displayName != null) {
_json["displayName"] = displayName;
}
if (labels != null) {
_json["labels"] = labels;
}
if (locationId != null) {
_json["locationId"] = locationId;
}
if (metadata != null) {
_json["metadata"] = metadata;
}
if (name != null) {
_json["name"] = name;
}
return _json;
}
}
/// This resource represents a long-running operation that is the result of a
/// network API call.
class Operation {
/// If the value is `false`, it means the operation is still in progress. If
/// `true`, the operation is completed, and either `error` or `response` is
/// available.
core.bool done;
/// The error result of the operation in case of failure or cancellation.
Status error;
/// Service-specific metadata associated with the operation. It typically
/// contains progress information and common metadata such as create time.
/// Some services might not provide such metadata. Any method that returns a
/// long-running operation should document the metadata type, if any.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> metadata;
/// The server-assigned name, which is only unique within the same service
/// that originally returns it. If you use the default HTTP mapping, the
/// `name` should be a resource name ending with `operations/{unique_id}`.
core.String name;
/// The normal response of the operation in case of success. If the original
/// method returns no data on success, such as `Delete`, the response is
/// `google.protobuf.Empty`. If the original method is standard
/// `Get`/`Create`/`Update`, the response should be the resource. For other
/// methods, the response should have the type `XxxResponse`, where `Xxx` is
/// the original method name. For example, if the original method name is
/// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> response;
Operation();
Operation.fromJson(core.Map _json) {
if (_json.containsKey("done")) {
done = _json["done"];
}
if (_json.containsKey("error")) {
error = new Status.fromJson(_json["error"]);
}
if (_json.containsKey("metadata")) {
metadata =
(_json["metadata"] as core.Map).cast<core.String, core.Object>();
}
if (_json.containsKey("name")) {
name = _json["name"];
}
if (_json.containsKey("response")) {
response =
(_json["response"] as core.Map).cast<core.String, core.Object>();
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (done != null) {
_json["done"] = done;
}
if (error != null) {
_json["error"] = (error).toJson();
}
if (metadata != null) {
_json["metadata"] = metadata;
}
if (name != null) {
_json["name"] = name;
}
if (response != null) {
_json["response"] = response;
}
return _json;
}
}
/// Metadata describing an Operation
class OperationMetadataV1 {
/// The Cloud Build ID of the function created or updated by an API call. This
/// field is only populated for Create and Update operations.
core.String buildId;
/// The original request that started the operation.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> request;
/// Target of the operation - for example
/// projects/project-1/locations/region-1/functions/function-1
core.String target;
/// Type of operation.
/// Possible string values are:
/// - "OPERATION_UNSPECIFIED" : Unknown operation type.
/// - "CREATE_FUNCTION" : Triggered by CreateFunction call
/// - "UPDATE_FUNCTION" : Triggered by UpdateFunction call
/// - "DELETE_FUNCTION" : Triggered by DeleteFunction call.
core.String type;
/// The last update timestamp of the operation.
core.String updateTime;
/// Version id of the function created or updated by an API call. This field
/// is only populated for Create and Update operations.
core.String versionId;
OperationMetadataV1();
OperationMetadataV1.fromJson(core.Map _json) {
if (_json.containsKey("buildId")) {
buildId = _json["buildId"];
}
if (_json.containsKey("request")) {
request = (_json["request"] as core.Map).cast<core.String, core.Object>();
}
if (_json.containsKey("target")) {
target = _json["target"];
}
if (_json.containsKey("type")) {
type = _json["type"];
}
if (_json.containsKey("updateTime")) {
updateTime = _json["updateTime"];
}
if (_json.containsKey("versionId")) {
versionId = _json["versionId"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (buildId != null) {
_json["buildId"] = buildId;
}
if (request != null) {
_json["request"] = request;
}
if (target != null) {
_json["target"] = target;
}
if (type != null) {
_json["type"] = type;
}
if (updateTime != null) {
_json["updateTime"] = updateTime;
}
if (versionId != null) {
_json["versionId"] = versionId;
}
return _json;
}
}
/// An Identity and Access Management (IAM) policy, which specifies access
/// controls for Google Cloud resources. A `Policy` is a collection of
/// `bindings`. A `binding` binds one or more `members` to a single `role`.
/// Members can be user accounts, service accounts, Google groups, and domains
/// (such as G Suite). A `role` is a named list of permissions; each `role` can
/// be an IAM predefined role or a user-created custom role. For some types of
/// Google Cloud resources, a `binding` can also specify a `condition`, which is
/// a logical expression that allows access to a resource only if the expression
/// evaluates to `true`. A condition can add constraints based on attributes of
/// the request, the resource, or both. To learn which resources support
/// conditions in their IAM policies, see the [IAM
/// documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
/// **JSON example:** { "bindings": [ { "role":
/// "roles/resourcemanager.organizationAdmin", "members": [
/// "user:mike@example.com", "group:admins@example.com", "domain:google.com",
/// "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role":
/// "roles/resourcemanager.organizationViewer", "members": [
/// "user:eve@example.com" ], "condition": { "title": "expirable access",
/// "description": "Does not grant access after Sep 2020", "expression":
/// "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag":
/// "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: -
/// user:mike@example.com - group:admins@example.com - domain:google.com -
/// serviceAccount:my-project-id@appspot.gserviceaccount.com role:
/// roles/resourcemanager.organizationAdmin - members: - user:eve@example.com
/// role: roles/resourcemanager.organizationViewer condition: title: expirable
/// access description: Does not grant access after Sep 2020 expression:
/// request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= -
/// version: 3 For a description of IAM and its features, see the [IAM
/// documentation](https://cloud.google.com/iam/docs/).
class Policy {
/// Specifies cloud audit logging configuration for this policy.
core.List<AuditConfig> auditConfigs;
/// Associates a list of `members` to a `role`. Optionally, may specify a
/// `condition` that determines how and when the `bindings` are applied. Each
/// of the `bindings` must contain at least one member.
core.List<Binding> bindings;
/// `etag` is used for optimistic concurrency control as a way to help prevent
/// simultaneous updates of a policy from overwriting each other. It is
/// strongly suggested that systems make use of the `etag` in the
/// read-modify-write cycle to perform policy updates in order to avoid race
/// conditions: An `etag` is returned in the response to `getIamPolicy`, and
/// systems are expected to put that etag in the request to `setIamPolicy` to
/// ensure that their change will be applied to the same version of the
/// policy. **Important:** If you use IAM Conditions, you must include the
/// `etag` field whenever you call `setIamPolicy`. If you omit this field,
/// then IAM allows you to overwrite a version `3` policy with a version `1`
/// policy, and all of the conditions in the version `3` policy are lost.
core.String etag;
core.List<core.int> get etagAsBytes {
return convert.base64.decode(etag);
}
set etagAsBytes(core.List<core.int> _bytes) {
etag =
convert.base64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
/// Specifies the format of the policy. Valid values are `0`, `1`, and `3`.
/// Requests that specify an invalid value are rejected. Any operation that
/// affects conditional role bindings must specify version `3`. This
/// requirement applies to the following operations: * Getting a policy that
/// includes a conditional role binding * Adding a conditional role binding to
/// a policy * Changing a conditional role binding in a policy * Removing any
/// role binding, with or without a condition, from a policy that includes
/// conditions **Important:** If you use IAM Conditions, you must include the
/// `etag` field whenever you call `setIamPolicy`. If you omit this field,
/// then IAM allows you to overwrite a version `3` policy with a version `1`
/// policy, and all of the conditions in the version `3` policy are lost. If a
/// policy does not include any conditions, operations on that policy may
/// specify any valid version or leave the field unset. To learn which
/// resources support conditions in their IAM policies, see the [IAM
/// documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
core.int version;
Policy();
Policy.fromJson(core.Map _json) {
if (_json.containsKey("auditConfigs")) {
auditConfigs = (_json["auditConfigs"] as core.List)
.map<AuditConfig>((value) => new AuditConfig.fromJson(value))
.toList();
}
if (_json.containsKey("bindings")) {
bindings = (_json["bindings"] as core.List)
.map<Binding>((value) => new Binding.fromJson(value))
.toList();
}
if (_json.containsKey("etag")) {
etag = _json["etag"];
}
if (_json.containsKey("version")) {
version = _json["version"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (auditConfigs != null) {
_json["auditConfigs"] =
auditConfigs.map((value) => (value).toJson()).toList();
}
if (bindings != null) {
_json["bindings"] = bindings.map((value) => (value).toJson()).toList();
}
if (etag != null) {
_json["etag"] = etag;
}
if (version != null) {
_json["version"] = version;
}
return _json;
}
}
/// Describes the retry policy in case of function's execution failure. A
/// function execution will be retried on any failure. A failed execution will
/// be retried up to 7 days with an exponential backoff (capped at 10 seconds).
/// Retried execution is charged as any other execution.
class Retry {
Retry();
Retry.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
return _json;
}
}
/// Request message for `SetIamPolicy` method.
class SetIamPolicyRequest {
/// REQUIRED: The complete policy to be applied to the `resource`. The size of
/// the policy is limited to a few 10s of KB. An empty policy is a valid
/// policy but certain Cloud Platform services (such as Projects) might reject
/// them.
Policy policy;
/// OPTIONAL: A FieldMask specifying which fields of the policy to modify.
/// Only the fields in the mask will be modified. If no mask is provided, the
/// following default mask is used: `paths: "bindings, etag"`
core.String updateMask;
SetIamPolicyRequest();
SetIamPolicyRequest.fromJson(core.Map _json) {
if (_json.containsKey("policy")) {
policy = new Policy.fromJson(_json["policy"]);
}
if (_json.containsKey("updateMask")) {
updateMask = _json["updateMask"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (policy != null) {
_json["policy"] = (policy).toJson();
}
if (updateMask != null) {
_json["updateMask"] = updateMask;
}
return _json;
}
}
/// Describes SourceRepository, used to represent parameters related to source
/// repository where a function is hosted.
class SourceRepository {
/// Output only. The URL pointing to the hosted repository where the function
/// were defined at the time of deployment. It always points to a specific
/// commit in the format described above.
core.String deployedUrl;
/// The URL pointing to the hosted repository where the function is defined.
/// There are supported Cloud Source Repository URLs in the following formats:
/// To refer to a specific commit:
/// `https://source.developers.google.com/projects / * /repos / * /revisions /
/// * /paths / * ` To refer to a moveable alias (branch):
/// `https://source.developers.google.com/projects / * /repos / *
/// /moveable-aliases / * /paths / * ` In particular, to refer to HEAD use
/// `master` moveable alias. To refer to a specific fixed alias (tag):
/// `https://source.developers.google.com/projects / * /repos / *
/// /fixed-aliases / * /paths / * ` You may omit `paths / * ` if you want to
/// use the main directory.
core.String url;
SourceRepository();
SourceRepository.fromJson(core.Map _json) {
if (_json.containsKey("deployedUrl")) {
deployedUrl = _json["deployedUrl"];
}
if (_json.containsKey("url")) {
url = _json["url"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (deployedUrl != null) {
_json["deployedUrl"] = deployedUrl;
}
if (url != null) {
_json["url"] = url;
}
return _json;
}
}
/// The `Status` type defines a logical error model that is suitable for
/// different programming environments, including REST APIs and RPC APIs. It is
/// used by [gRPC](https://github.com/grpc). Each `Status` message contains
/// three pieces of data: error code, error message, and error details. You can
/// find out more about this error model and how to work with it in the [API
/// Design Guide](https://cloud.google.com/apis/design/errors).
class Status {
/// The status code, which should be an enum value of google.rpc.Code.
core.int code;
/// A list of messages that carry the error details. There is a common set of
/// message types for APIs to use.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.List<core.Map<core.String, core.Object>> details;
/// A developer-facing error message, which should be in English. Any
/// user-facing error message should be localized and sent in the
/// google.rpc.Status.details field, or localized by the client.
core.String message;
Status();
Status.fromJson(core.Map _json) {
if (_json.containsKey("code")) {
code = _json["code"];
}
if (_json.containsKey("details")) {
details = (_json["details"] as core.List)
.map<core.Map<core.String, core.Object>>(
(value) => (value as core.Map).cast<core.String, core.Object>())
.toList();
}
if (_json.containsKey("message")) {
message = _json["message"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (code != null) {
_json["code"] = code;
}
if (details != null) {
_json["details"] = details;
}
if (message != null) {
_json["message"] = message;
}
return _json;
}
}
/// Request message for `TestIamPermissions` method.
class TestIamPermissionsRequest {
/// The set of permissions to check for the `resource`. Permissions with
/// wildcards (such as '*' or 'storage.*') are not allowed. For more
/// information see [IAM
/// Overview](https://cloud.google.com/iam/docs/overview#permissions).
core.List<core.String> permissions;
TestIamPermissionsRequest();
TestIamPermissionsRequest.fromJson(core.Map _json) {
if (_json.containsKey("permissions")) {
permissions = (_json["permissions"] as core.List).cast<core.String>();
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (permissions != null) {
_json["permissions"] = permissions;
}
return _json;
}
}
/// Response message for `TestIamPermissions` method.
class TestIamPermissionsResponse {
/// A subset of `TestPermissionsRequest.permissions` that the caller is
/// allowed.
core.List<core.String> permissions;
TestIamPermissionsResponse();
TestIamPermissionsResponse.fromJson(core.Map _json) {
if (_json.containsKey("permissions")) {
permissions = (_json["permissions"] as core.List).cast<core.String>();
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (permissions != null) {
_json["permissions"] = permissions;
}
return _json;
}
}