google_api_cloud_functions

v0.1.0

google_api_cloud_functions v0.1.0 GoogleApi.CloudFunctions.V1.Api.Projects View Source

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

cloudfunctions_projects_locations_functions_call(connection, projects_id, locations_id, functions_id, opts \\ [])

Invokes synchronously deployed function. To be used for testing, very limited traffic allowed

cloudfunctions_projects_locations_functions_create(connection, projects_id, locations_id, opts \\ [])

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

cloudfunctions_projects_locations_functions_delete(connection, projects_id, locations_id, functions_id, opts \\ [])

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

cloudfunctions_projects_locations_functions_generate_download_url(connection, projects_id, locations_id, functions_id, opts \\ [])

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

cloudfunctions_projects_locations_functions_generate_upload_url(connection, projects_id, locations_id, opts \\ [])

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. When making a HTTP PUT request, these two headers need to be specified: `content-type: application/zip` `x-goog-content-length-range: 0,104857600`

cloudfunctions_projects_locations_functions_get(connection, projects_id, locations_id, functions_id, opts \\ [])

Returns a function with the given name from the requested project

cloudfunctions_projects_locations_functions_list(connection, projects_id, locations_id, opts \\ [])

Returns a list of functions that belong to the requested project

cloudfunctions_projects_locations_functions_patch(connection, projects_id, locations_id, functions_id, opts \\ [])

Updates existing function

cloudfunctions_projects_locations_list(connection, projects_id, opts \\ [])

Lists information about the supported locations for this service

Link to this section Functions

Link to this function cloudfunctions_projects_locations_functions_call(connection, projects_id, locations_id, functions_id, opts \\ []) View Source 
cloudfunctions_projects_locations_functions_call(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudFunctions.V1.Model.CallFunctionResponse.t()}
  | {:error, Tesla.Env.t()}

Invokes synchronously deployed function. To be used for testing, very limited traffic allowed.

Parameters

  • connection (GoogleApi.CloudFunctions.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. The name of the function to be called.
  • locations_id (String.t): Part of `name`. See documentation of `projectsId`.
  • functions_id (String.t): Part of `name`. See documentation of `projectsId`.

  • opts (KeywordList): [optional] Optional parameters

    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (CallFunctionRequest):

Returns

{:ok, %GoogleApi.CloudFunctions.V1.Model.CallFunctionResponse{}} on success {:error, info} on failure

Link to this function cloudfunctions_projects_locations_functions_create(connection, projects_id, locations_id, opts \\ []) View Source 
cloudfunctions_projects_locations_functions_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudFunctions.V1.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (GoogleApi.CloudFunctions.V1.Connection): Connection to server
  • projects_id (String.t): Part of `location`. The project and location in which the function should be created, specified in the format `projects//locations/`
  • locations_id (String.t): Part of `location`. See documentation of `projectsId`.

  • opts (KeywordList): [optional] Optional parameters

    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (CloudFunction):

Returns

{:ok, %GoogleApi.CloudFunctions.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function cloudfunctions_projects_locations_functions_delete(connection, projects_id, locations_id, functions_id, opts \\ []) View Source 
cloudfunctions_projects_locations_functions_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudFunctions.V1.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (GoogleApi.CloudFunctions.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. The name of the function which should be deleted.
  • locations_id (String.t): Part of `name`. See documentation of `projectsId`.
  • functions_id (String.t): Part of `name`. See documentation of `projectsId`.

  • opts (KeywordList): [optional] Optional parameters

    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.CloudFunctions.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function cloudfunctions_projects_locations_functions_generate_download_url(connection, projects_id, locations_id, functions_id, opts \\ []) View Source 
cloudfunctions_projects_locations_functions_generate_download_url(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudFunctions.V1.Model.GenerateDownloadUrlResponse.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (GoogleApi.CloudFunctions.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. The name of function for which source code Google Cloud Storage signed URL should be generated.
  • locations_id (String.t): Part of `name`. See documentation of `projectsId`.
  • functions_id (String.t): Part of `name`. See documentation of `projectsId`.

  • opts (KeywordList): [optional] Optional parameters

    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GenerateDownloadUrlRequest):

Returns

{:ok, %GoogleApi.CloudFunctions.V1.Model.GenerateDownloadUrlResponse{}} on success {:error, info} on failure

Link to this function cloudfunctions_projects_locations_functions_generate_upload_url(connection, projects_id, locations_id, opts \\ []) View Source 
cloudfunctions_projects_locations_functions_generate_upload_url(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudFunctions.V1.Model.GenerateUploadUrlResponse.t()}
  | {:error, Tesla.Env.t()}

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. When making a HTTP PUT request, these two headers need to be specified: `content-type: application/zip` `x-goog-content-length-range: 0,104857600`

Parameters

  • connection (GoogleApi.CloudFunctions.V1.Connection): Connection to server
  • projects_id (String.t): Part of `parent`. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format `projects//locations/`.
  • locations_id (String.t): Part of `parent`. See documentation of `projectsId`.

  • opts (KeywordList): [optional] Optional parameters

    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GenerateUploadUrlRequest):

Returns

{:ok, %GoogleApi.CloudFunctions.V1.Model.GenerateUploadUrlResponse{}} on success {:error, info} on failure

Link to this function cloudfunctions_projects_locations_functions_get(connection, projects_id, locations_id, functions_id, opts \\ []) View Source 
cloudfunctions_projects_locations_functions_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudFunctions.V1.Model.CloudFunction.t()}
  | {:error, Tesla.Env.t()}

Returns a function with the given name from the requested project.

Parameters

  • connection (GoogleApi.CloudFunctions.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. The name of the function which details should be obtained.
  • locations_id (String.t): Part of `name`. See documentation of `projectsId`.
  • functions_id (String.t): Part of `name`. See documentation of `projectsId`.

  • opts (KeywordList): [optional] Optional parameters

    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.CloudFunctions.V1.Model.CloudFunction{}} on success {:error, info} on failure

Link to this function cloudfunctions_projects_locations_functions_list(connection, projects_id, locations_id, opts \\ []) View Source 
cloudfunctions_projects_locations_functions_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudFunctions.V1.Model.ListFunctionsResponse.t()}
  | {:error, Tesla.Env.t()}

Returns a list of functions that belong to the requested project.

Parameters

  • connection (GoogleApi.CloudFunctions.V1.Connection): Connection to server
  • projects_id (String.t): Part of `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.
  • locations_id (String.t): Part of `parent`. See documentation of `projectsId`.

  • opts (KeywordList): [optional] Optional parameters

    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :pageToken (String.t): 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.
    • :pageSize (integer()): Maximum number of functions to return per call.

Returns

{:ok, %GoogleApi.CloudFunctions.V1.Model.ListFunctionsResponse{}} on success {:error, info} on failure

Link to this function cloudfunctions_projects_locations_functions_patch(connection, projects_id, locations_id, functions_id, opts \\ []) View Source 
cloudfunctions_projects_locations_functions_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudFunctions.V1.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

Updates existing function.

Parameters

  • connection (GoogleApi.CloudFunctions.V1.Connection): Connection to server
  • projects_id (String.t): Part of `function.name`. A user-defined name of the function. Function names must be unique globally and match pattern `projects//locations//functions/*`
  • locations_id (String.t): Part of `function.name`. See documentation of `projectsId`.
  • functions_id (String.t): Part of `function.name`. See documentation of `projectsId`.

  • opts (KeywordList): [optional] Optional parameters

    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (String.t): Required list of fields to be updated in this request.
    • :body (CloudFunction):

Returns

{:ok, %GoogleApi.CloudFunctions.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function cloudfunctions_projects_locations_list(connection, projects_id, opts \\ []) View Source 
cloudfunctions_projects_locations_list(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudFunctions.V1.Model.ListLocationsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists information about the supported locations for this service.

Parameters

  • connection (GoogleApi.CloudFunctions.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. The resource that owns the locations collection, if applicable.

  • opts (KeywordList): [optional] Optional parameters

    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :$.xgafv (String.t): V1 error format.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :access_token (String.t): OAuth access token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :filter (String.t): The standard list filter.
    • :pageToken (String.t): The standard list page token.
    • :pageSize (integer()): The standard list page size.

Returns

{:ok, %GoogleApi.CloudFunctions.V1.Model.ListLocationsResponse{}} on success {:error, info} on failure