chore: regens API reference docs (#889)
diff --git a/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html b/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html
index 6ce45b2..693ea16 100644
--- a/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html
+++ b/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html
@@ -75,16 +75,16 @@
<h1><a href="cloudfunctions_v1beta2.html">Cloud Functions API</a> . <a href="cloudfunctions_v1beta2.projects.html">projects</a> . <a href="cloudfunctions_v1beta2.projects.locations.html">locations</a> . <a href="cloudfunctions_v1beta2.projects.locations.functions.html">functions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#call">call(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#call">call(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Synchronously invokes a deployed Cloud Function. To be used for testing</p>
<p class="toc_element">
- <code><a href="#create">create(location, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(location, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new function. If a function with the given name already exists in</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a function with the given name from the specified project. If the</p>
<p class="toc_element">
- <code><a href="#generateDownloadUrl">generateDownloadUrl(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#generateDownloadUrl">generateDownloadUrl(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a signed URL for downloading deployed function source code.</p>
<p class="toc_element">
<code><a href="#generateUploadUrl">generateUploadUrl(parent, body=None, x__xgafv=None)</a></code></p>
@@ -99,23 +99,23 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates existing function.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="call">call(name, body, x__xgafv=None)</code>
+ <code class="details" id="call">call(name, body=None, x__xgafv=None)</code>
<pre>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 [API Calls](
https://cloud.google.com/functions/quotas#rate_limits).
Args:
- name: string, The name of the function to be called. (required)
- body: object, The request body. (required)
+ name: string, Required. The name of the function to be called. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request for the `CallFunction` method.
- "data": "A String", # Input to be passed to the function.
+ "data": "A String", # Required. Input to be passed to the function.
}
x__xgafv: string, V1 error format.
@@ -136,15 +136,15 @@
</div>
<div class="method">
- <code class="details" id="create">create(location, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(location, body=None, x__xgafv=None)</code>
<pre>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.
Args:
- location: string, The project and location in which the function should be created, specified
+ location: string, Required. The project and location in which the function should be created, specified
in the format `projects/*/locations/*` (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Describes a Cloud Function that contains user computation executed in
@@ -152,16 +152,15 @@
"status": "A String", # Output only. Status of the function deployment.
"eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service.
# service.
- "eventType": "A String", # `event_type` names contain the service that is sending an event and the
- # kind of event that was fired. Must be of the form
- # `providers/*/eventTypes/*` e.g. Directly handle a Message published to
- # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.
- #
- # Handle an object changing in Google Cloud Storage:
- # `providers/cloud.storage/eventTypes/object.change`
- #
- # Handle a write to the Firebase Realtime Database:
- # `providers/google.firebase.database/eventTypes/ref.write`
+ "failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.
+ # If empty, then defaults to ignoring failures (i.e. not retrying them).
+ "retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a 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.
+ },
+ },
"resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub
# this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud
# Storage this would be a bucket at `projects/*/buckets/*`. For any source
@@ -172,19 +171,32 @@
# 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.
- "failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.
- # If empty, then defaults to ignoring failures (i.e. not retrying them).
- "retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a 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.
- },
- },
+ "eventType": "A String", # `event_type` names contain the service that is sending an event and the
+ # kind of event that was fired. Must be of the form
+ # `providers/*/eventTypes/*` e.g. Directly handle a Message published to
+ # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.
+ #
+ # Handle an object changing in Google Cloud Storage:
+ # `providers/cloud.storage/eventTypes/object.change`
+ #
+ # Handle a write to the Firebase Realtime Database:
+ # `providers/google.firebase.database/eventTypes/ref.write`
},
"updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
- "name": "A String", # A user-defined name of the function. Function names must be unique
- # globally and match pattern `projects/*/locations/*/functions/*`
+ "network": "A String", # 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.
"maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
# given time.
"sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.
@@ -211,20 +223,27 @@
"httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.
"url": "A String", # Output only. The deployed url for the function.
},
- "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
- # archive which contains the function.
+ "vpcConnector": "A String", # 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.
"labels": { # Labels associated with this Cloud Function.
"a_key": "A String",
},
"serviceAccount": "A String", # The email of the function's service account. If empty, defaults to
- # {project_id}@appspot.gserviceaccount.com.
+ # `{project_id}@appspot.gserviceaccount.com`.
"environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
"availableMemoryMb": 42, # The amount of memory in MB available for a function.
# Defaults to 256MB.
- "versionId": "A String", # Output only.
- # The version identifier of the Cloud Function. Each deployment attempt
+ "versionId": "A String", # Output only. The version identifier of the Cloud Function. Each deployment attempt
# results in a new version of a function being created.
"entryPoint": "A String", # The name of the function (as defined in source code) that will be
# executed. Defaults to the resource name suffix, if not specified. For
@@ -251,41 +270,15 @@
# `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`
#
# You may omit `paths/*` if you want to use the main directory.
- "runtime": "A String", # Required. The runtime in which the function is going to run. Choices:
- #
- # * `nodejs6`: Node.js 6
- # * `nodejs8`: Node.js 8
- # * `nodejs10`: Node.js 10
- # * `python37`: Python 3.7
- # * `go111`: Go 1.11
- "vpcConnector": "A String", # 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.
- #
- # This feature is currently in alpha, available only for whitelisted users.
- "network": "A String", # 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.
- #
- # This feature is currently in alpha, available only for whitelisted users.
+ "runtime": "A String", # 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).
+ "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
+ # archive which contains the function.
+ "name": "A String", # A user-defined name of the function. Function names must be unique
+ # globally and match pattern `projects/*/locations/*/functions/*`
}
x__xgafv: string, V1 error format.
@@ -306,56 +299,11 @@
},
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # 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).
"message": "A String", # 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.
@@ -393,7 +341,7 @@
remove this function.
Args:
- name: string, The name of the function which should be deleted. (required)
+ name: string, Required. The name of the function which should be deleted. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -412,56 +360,11 @@
},
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # 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).
"message": "A String", # 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.
@@ -493,7 +396,7 @@
</div>
<div class="method">
- <code class="details" id="generateDownloadUrl">generateDownloadUrl(name, body, x__xgafv=None)</code>
+ <code class="details" id="generateDownloadUrl">generateDownloadUrl(name, body=None, x__xgafv=None)</code>
<pre>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.
@@ -503,7 +406,7 @@
Args:
name: string, The name of function for which source code Google Cloud Storage signed
URL should be generated. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request of `GenerateDownloadUrl` method.
@@ -581,7 +484,7 @@
<pre>Returns a function with the given name from the requested project.
Args:
- name: string, The name of the function which details should be obtained. (required)
+ name: string, Required. The name of the function which details should be obtained. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -595,16 +498,15 @@
"status": "A String", # Output only. Status of the function deployment.
"eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service.
# service.
- "eventType": "A String", # `event_type` names contain the service that is sending an event and the
- # kind of event that was fired. Must be of the form
- # `providers/*/eventTypes/*` e.g. Directly handle a Message published to
- # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.
- #
- # Handle an object changing in Google Cloud Storage:
- # `providers/cloud.storage/eventTypes/object.change`
- #
- # Handle a write to the Firebase Realtime Database:
- # `providers/google.firebase.database/eventTypes/ref.write`
+ "failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.
+ # If empty, then defaults to ignoring failures (i.e. not retrying them).
+ "retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a 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.
+ },
+ },
"resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub
# this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud
# Storage this would be a bucket at `projects/*/buckets/*`. For any source
@@ -615,19 +517,32 @@
# 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.
- "failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.
- # If empty, then defaults to ignoring failures (i.e. not retrying them).
- "retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a 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.
- },
- },
+ "eventType": "A String", # `event_type` names contain the service that is sending an event and the
+ # kind of event that was fired. Must be of the form
+ # `providers/*/eventTypes/*` e.g. Directly handle a Message published to
+ # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.
+ #
+ # Handle an object changing in Google Cloud Storage:
+ # `providers/cloud.storage/eventTypes/object.change`
+ #
+ # Handle a write to the Firebase Realtime Database:
+ # `providers/google.firebase.database/eventTypes/ref.write`
},
"updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
- "name": "A String", # A user-defined name of the function. Function names must be unique
- # globally and match pattern `projects/*/locations/*/functions/*`
+ "network": "A String", # 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.
"maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
# given time.
"sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.
@@ -654,20 +569,27 @@
"httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.
"url": "A String", # Output only. The deployed url for the function.
},
- "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
- # archive which contains the function.
+ "vpcConnector": "A String", # 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.
"labels": { # Labels associated with this Cloud Function.
"a_key": "A String",
},
"serviceAccount": "A String", # The email of the function's service account. If empty, defaults to
- # {project_id}@appspot.gserviceaccount.com.
+ # `{project_id}@appspot.gserviceaccount.com`.
"environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
"availableMemoryMb": 42, # The amount of memory in MB available for a function.
# Defaults to 256MB.
- "versionId": "A String", # Output only.
- # The version identifier of the Cloud Function. Each deployment attempt
+ "versionId": "A String", # Output only. The version identifier of the Cloud Function. Each deployment attempt
# results in a new version of a function being created.
"entryPoint": "A String", # The name of the function (as defined in source code) that will be
# executed. Defaults to the resource name suffix, if not specified. For
@@ -694,41 +616,15 @@
# `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`
#
# You may omit `paths/*` if you want to use the main directory.
- "runtime": "A String", # Required. The runtime in which the function is going to run. Choices:
- #
- # * `nodejs6`: Node.js 6
- # * `nodejs8`: Node.js 8
- # * `nodejs10`: Node.js 10
- # * `python37`: Python 3.7
- # * `go111`: Go 1.11
- "vpcConnector": "A String", # 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.
- #
- # This feature is currently in alpha, available only for whitelisted users.
- "network": "A String", # 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.
- #
- # This feature is currently in alpha, available only for whitelisted users.
+ "runtime": "A String", # 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).
+ "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
+ # archive which contains the function.
+ "name": "A String", # A user-defined name of the function. Function names must be unique
+ # globally and match pattern `projects/*/locations/*/functions/*`
}</pre>
</div>
@@ -737,10 +633,12 @@
<pre>Returns a list of functions that belong to the requested project.
Args:
- location: string, The project and location from which the function should be listed,
+ location: string, Required. 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. (required)
+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. (required)
pageSize: integer, Maximum number of functions to return per call.
pageToken: string, The value returned by the last
`ListFunctionsResponse`; indicates that
@@ -759,22 +657,25 @@
# the request; this value should be passed in a new
# google.cloud.functions.v1beta2.ListFunctionsRequest
# to get more functions.
+ "unreachable": [ # Locations that could not be reached. The response does not include any
+ # functions from these locations.
+ "A String",
+ ],
"functions": [ # The functions that match the request.
{ # Describes a Cloud Function that contains user computation executed in
# response to an event. It encapsulate function and triggers configurations.
"status": "A String", # Output only. Status of the function deployment.
"eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service.
# service.
- "eventType": "A String", # `event_type` names contain the service that is sending an event and the
- # kind of event that was fired. Must be of the form
- # `providers/*/eventTypes/*` e.g. Directly handle a Message published to
- # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.
- #
- # Handle an object changing in Google Cloud Storage:
- # `providers/cloud.storage/eventTypes/object.change`
- #
- # Handle a write to the Firebase Realtime Database:
- # `providers/google.firebase.database/eventTypes/ref.write`
+ "failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.
+ # If empty, then defaults to ignoring failures (i.e. not retrying them).
+ "retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a 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.
+ },
+ },
"resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub
# this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud
# Storage this would be a bucket at `projects/*/buckets/*`. For any source
@@ -785,19 +686,32 @@
# 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.
- "failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.
- # If empty, then defaults to ignoring failures (i.e. not retrying them).
- "retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a 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.
- },
- },
+ "eventType": "A String", # `event_type` names contain the service that is sending an event and the
+ # kind of event that was fired. Must be of the form
+ # `providers/*/eventTypes/*` e.g. Directly handle a Message published to
+ # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.
+ #
+ # Handle an object changing in Google Cloud Storage:
+ # `providers/cloud.storage/eventTypes/object.change`
+ #
+ # Handle a write to the Firebase Realtime Database:
+ # `providers/google.firebase.database/eventTypes/ref.write`
},
"updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
- "name": "A String", # A user-defined name of the function. Function names must be unique
- # globally and match pattern `projects/*/locations/*/functions/*`
+ "network": "A String", # 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.
"maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
# given time.
"sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.
@@ -824,20 +738,27 @@
"httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.
"url": "A String", # Output only. The deployed url for the function.
},
- "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
- # archive which contains the function.
+ "vpcConnector": "A String", # 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.
"labels": { # Labels associated with this Cloud Function.
"a_key": "A String",
},
"serviceAccount": "A String", # The email of the function's service account. If empty, defaults to
- # {project_id}@appspot.gserviceaccount.com.
+ # `{project_id}@appspot.gserviceaccount.com`.
"environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
"availableMemoryMb": 42, # The amount of memory in MB available for a function.
# Defaults to 256MB.
- "versionId": "A String", # Output only.
- # The version identifier of the Cloud Function. Each deployment attempt
+ "versionId": "A String", # Output only. The version identifier of the Cloud Function. Each deployment attempt
# results in a new version of a function being created.
"entryPoint": "A String", # The name of the function (as defined in source code) that will be
# executed. Defaults to the resource name suffix, if not specified. For
@@ -864,41 +785,15 @@
# `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`
#
# You may omit `paths/*` if you want to use the main directory.
- "runtime": "A String", # Required. The runtime in which the function is going to run. Choices:
- #
- # * `nodejs6`: Node.js 6
- # * `nodejs8`: Node.js 8
- # * `nodejs10`: Node.js 10
- # * `python37`: Python 3.7
- # * `go111`: Go 1.11
- "vpcConnector": "A String", # 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.
- #
- # This feature is currently in alpha, available only for whitelisted users.
- "network": "A String", # 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.
- #
- # This feature is currently in alpha, available only for whitelisted users.
+ "runtime": "A String", # 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).
+ "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
+ # archive which contains the function.
+ "name": "A String", # A user-defined name of the function. Function names must be unique
+ # globally and match pattern `projects/*/locations/*/functions/*`
},
],
}</pre>
@@ -919,12 +814,12 @@
</div>
<div class="method">
- <code class="details" id="update">update(name, body, x__xgafv=None)</code>
+ <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
<pre>Updates existing function.
Args:
- name: string, The name of the function to be updated. (required)
- body: object, The request body. (required)
+ name: string, Required. The name of the function to be updated. (required)
+ body: object, The request body.
The object takes the form of:
{ # Describes a Cloud Function that contains user computation executed in
@@ -932,16 +827,15 @@
"status": "A String", # Output only. Status of the function deployment.
"eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service.
# service.
- "eventType": "A String", # `event_type` names contain the service that is sending an event and the
- # kind of event that was fired. Must be of the form
- # `providers/*/eventTypes/*` e.g. Directly handle a Message published to
- # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.
- #
- # Handle an object changing in Google Cloud Storage:
- # `providers/cloud.storage/eventTypes/object.change`
- #
- # Handle a write to the Firebase Realtime Database:
- # `providers/google.firebase.database/eventTypes/ref.write`
+ "failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.
+ # If empty, then defaults to ignoring failures (i.e. not retrying them).
+ "retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a 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.
+ },
+ },
"resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub
# this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud
# Storage this would be a bucket at `projects/*/buckets/*`. For any source
@@ -952,19 +846,32 @@
# 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.
- "failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.
- # If empty, then defaults to ignoring failures (i.e. not retrying them).
- "retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a 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.
- },
- },
+ "eventType": "A String", # `event_type` names contain the service that is sending an event and the
+ # kind of event that was fired. Must be of the form
+ # `providers/*/eventTypes/*` e.g. Directly handle a Message published to
+ # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.
+ #
+ # Handle an object changing in Google Cloud Storage:
+ # `providers/cloud.storage/eventTypes/object.change`
+ #
+ # Handle a write to the Firebase Realtime Database:
+ # `providers/google.firebase.database/eventTypes/ref.write`
},
"updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
- "name": "A String", # A user-defined name of the function. Function names must be unique
- # globally and match pattern `projects/*/locations/*/functions/*`
+ "network": "A String", # 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.
"maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
# given time.
"sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.
@@ -991,20 +898,27 @@
"httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.
"url": "A String", # Output only. The deployed url for the function.
},
- "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
- # archive which contains the function.
+ "vpcConnector": "A String", # 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.
"labels": { # Labels associated with this Cloud Function.
"a_key": "A String",
},
"serviceAccount": "A String", # The email of the function's service account. If empty, defaults to
- # {project_id}@appspot.gserviceaccount.com.
+ # `{project_id}@appspot.gserviceaccount.com`.
"environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
"availableMemoryMb": 42, # The amount of memory in MB available for a function.
# Defaults to 256MB.
- "versionId": "A String", # Output only.
- # The version identifier of the Cloud Function. Each deployment attempt
+ "versionId": "A String", # Output only. The version identifier of the Cloud Function. Each deployment attempt
# results in a new version of a function being created.
"entryPoint": "A String", # The name of the function (as defined in source code) that will be
# executed. Defaults to the resource name suffix, if not specified. For
@@ -1031,41 +945,15 @@
# `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`
#
# You may omit `paths/*` if you want to use the main directory.
- "runtime": "A String", # Required. The runtime in which the function is going to run. Choices:
- #
- # * `nodejs6`: Node.js 6
- # * `nodejs8`: Node.js 8
- # * `nodejs10`: Node.js 10
- # * `python37`: Python 3.7
- # * `go111`: Go 1.11
- "vpcConnector": "A String", # 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.
- #
- # This feature is currently in alpha, available only for whitelisted users.
- "network": "A String", # 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.
- #
- # This feature is currently in alpha, available only for whitelisted users.
+ "runtime": "A String", # 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).
+ "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
+ # archive which contains the function.
+ "name": "A String", # A user-defined name of the function. Function names must be unique
+ # globally and match pattern `projects/*/locations/*/functions/*`
}
x__xgafv: string, V1 error format.
@@ -1086,56 +974,11 @@
},
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # 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).
"message": "A String", # 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.