docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html b/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html
index 693ea16..9e1d5a8 100644
--- a/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html
+++ b/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html
@@ -93,7 +93,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a function with the given name from the requested project.</p>
<p class="toc_element">
- <code><a href="#list">list(location, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(location, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of functions that belong to the requested project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -115,7 +115,7 @@
The object takes the form of:
{ # Request for the `CallFunction` method.
- "data": "A String", # Required. Input to be passed to the function.
+ "data": "A String", # Required. Input to be passed to the function.
}
x__xgafv: string, V1 error format.
@@ -127,10 +127,10 @@
An object of the form:
{ # Response of `CallFunction` method.
- "executionId": "A String", # Execution id of function invocation.
- "result": "A String", # Result populated for successful execution of synchronous function. Will
+ "executionId": "A String", # Execution id of function invocation.
+ "result": "A String", # Result populated for successful execution of synchronous function. Will
# not be populated if function does not return a result through context.
- "error": "A String", # Either system or user-function generated error. Set if execution
+ "error": "A String", # Either system or user-function generated error. Set if execution
# was not successful.
}</pre>
</div>
@@ -149,41 +149,28 @@
{ # 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.
- "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
- # that only supports one instance per-project, this should be the name of the
- # project (`projects/*`)
- "service": "A String", # 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.
- "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`
+ "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
+ # archive which contains the function.
+ "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.
+ "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in
+ # https://source.developers.google.com domain are supported. The path should
+ # contain the name of the repository.
+ "tag": "A String", # The name of the tag that captures the state of the repository from
+ # which the function should be fetched.
+ "branch": "A String", # The name of the branch from which the function should be fetched.
+ "sourcePath": "A String", # The path within the repository where the function is defined. The path
+ # should point to the directory where Cloud Functions files are located. Use
+ # "/" if the function is defined directly in the root directory of a
+ # repository.
+ "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of
+ # function creation or update. For example when a user deployed from a
+ # branch, it will be the revision id of the latest change on this branch at
+ # that time. If user deployed from revision then this value will be always
+ # equal to the revision specified by the user.
+ "revision": "A String", # The id of the revision that captures the state of the repository from
+ # which the function should be fetched.
},
- "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
- "network": "A String", # The VPC Network that this cloud function can connect to. It can be
+ "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
@@ -197,33 +184,7 @@
#
# 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.
- "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in
- # https://source.developers.google.com domain are supported. The path should
- # contain the name of the repository.
- "sourcePath": "A String", # The path within the repository where the function is defined. The path
- # should point to the directory where Cloud Functions files are located. Use
- # "/" if the function is defined directly in the root directory of a
- # repository.
- "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of
- # function creation or update. For example when a user deployed from a
- # branch, it will be the revision id of the latest change on this branch at
- # that time. If user deployed from revision then this value will be always
- # equal to the revision specified by the user.
- "tag": "A String", # The name of the tag that captures the state of the repository from
- # which the function should be fetched.
- "branch": "A String", # The name of the branch from which the function should be fetched.
- "revision": "A String", # The id of the revision that captures the state of the repository from
- # which the function should be fetched.
- },
- "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
- # by google.cloud.functions.v1beta2.GenerateUploadUrl
- "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.
- },
- "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can
+ "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/*`
@@ -233,31 +194,16 @@
#
# 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`.
- "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
- # 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
+ "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
# backward compatibility, if function with given name is not found, then the
- # system will try to use function named "function".
+ # 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`.
- "timeout": "A String", # 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.
- "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If
- # the function status is `DEPLOYING` or `DELETING`, then it points to the
- # active operation.
- "sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined.
+ "labels": { # Labels associated with this Cloud Function.
+ "a_key": "A String",
+ },
+ "sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined.
# There are supported Cloud Source Repository URLs in the following
# formats:
#
@@ -270,15 +216,69 @@
# `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", # The runtime in which to run the function. Required when deploying a new
+ "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+ "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If
+ # the function status is `DEPLOYING` or `DELETING`, then it points to the
+ # active operation.
+ "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.
+ },
+ "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
+ # given time.
+ "environmentVariables": { # Environment variables that shall be available during function execution.
+ "a_key": "A String",
+ },
+ "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
+ # by google.cloud.functions.v1beta2.GenerateUploadUrl
+ "timeout": "A String", # 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.
+ "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.
+ "service": "A String", # 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.
+ "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`
+ "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
+ # that only supports one instance per-project, this should be the name of the
+ # project (`projects/*`)
+ },
+ "status": "A String", # Output only. Status of the function deployment.
+ "availableMemoryMb": 42, # The amount of memory in MB available for a function.
+ # Defaults to 256MB.
+ "name": "A String", # A user-defined name of the function. Function names must be unique
+ # globally and match pattern `projects/*/locations/*/functions/*`
+ "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/*`
+ "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.
+ "serviceAccount": "A String", # The email of the function's service account. If empty, defaults to
+ # `{project_id}@appspot.gserviceaccount.com`.
}
x__xgafv: string, V1 error format.
@@ -291,34 +291,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # 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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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). 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).
- "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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "done": True or False, # 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.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # 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
@@ -326,11 +302,35 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # 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}`.
+ "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). 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).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "metadata": { # 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
@@ -352,34 +352,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # 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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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). 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).
- "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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "done": True or False, # 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.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # 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
@@ -387,11 +363,35 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # 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}`.
+ "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). 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).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "metadata": { # 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
@@ -410,7 +410,7 @@
The object takes the form of:
{ # Request of `GenerateDownloadUrl` method.
- "versionId": "A String", # The optional version of function.
+ "versionId": "A String", # The optional version of function.
}
x__xgafv: string, V1 error format.
@@ -422,7 +422,7 @@
An object of the form:
{ # Response of `GenerateDownloadUrl` method.
- "downloadUrl": "A String", # The generated Google Cloud Storage signed URL that should be used for
+ "downloadUrl": "A String", # The generated Google Cloud Storage signed URL that should be used for
# function source code download.
}</pre>
</div>
@@ -473,7 +473,7 @@
An object of the form:
{ # Response of `GenerateUploadUrl` method.
- "uploadUrl": "A String", # The generated Google Cloud Storage signed URL that should be used for a
+ "uploadUrl": "A String", # 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.
}</pre>
@@ -495,41 +495,28 @@
{ # 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.
- "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
- # that only supports one instance per-project, this should be the name of the
- # project (`projects/*`)
- "service": "A String", # 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.
- "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`
+ "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
+ # archive which contains the function.
+ "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.
+ "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in
+ # https://source.developers.google.com domain are supported. The path should
+ # contain the name of the repository.
+ "tag": "A String", # The name of the tag that captures the state of the repository from
+ # which the function should be fetched.
+ "branch": "A String", # The name of the branch from which the function should be fetched.
+ "sourcePath": "A String", # The path within the repository where the function is defined. The path
+ # should point to the directory where Cloud Functions files are located. Use
+ # "/" if the function is defined directly in the root directory of a
+ # repository.
+ "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of
+ # function creation or update. For example when a user deployed from a
+ # branch, it will be the revision id of the latest change on this branch at
+ # that time. If user deployed from revision then this value will be always
+ # equal to the revision specified by the user.
+ "revision": "A String", # The id of the revision that captures the state of the repository from
+ # which the function should be fetched.
},
- "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
- "network": "A String", # The VPC Network that this cloud function can connect to. It can be
+ "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
@@ -543,33 +530,7 @@
#
# 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.
- "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in
- # https://source.developers.google.com domain are supported. The path should
- # contain the name of the repository.
- "sourcePath": "A String", # The path within the repository where the function is defined. The path
- # should point to the directory where Cloud Functions files are located. Use
- # "/" if the function is defined directly in the root directory of a
- # repository.
- "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of
- # function creation or update. For example when a user deployed from a
- # branch, it will be the revision id of the latest change on this branch at
- # that time. If user deployed from revision then this value will be always
- # equal to the revision specified by the user.
- "tag": "A String", # The name of the tag that captures the state of the repository from
- # which the function should be fetched.
- "branch": "A String", # The name of the branch from which the function should be fetched.
- "revision": "A String", # The id of the revision that captures the state of the repository from
- # which the function should be fetched.
- },
- "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
- # by google.cloud.functions.v1beta2.GenerateUploadUrl
- "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.
- },
- "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can
+ "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/*`
@@ -579,31 +540,16 @@
#
# 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`.
- "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
- # 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
+ "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
# backward compatibility, if function with given name is not found, then the
- # system will try to use function named "function".
+ # 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`.
- "timeout": "A String", # 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.
- "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If
- # the function status is `DEPLOYING` or `DELETING`, then it points to the
- # active operation.
- "sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined.
+ "labels": { # Labels associated with this Cloud Function.
+ "a_key": "A String",
+ },
+ "sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined.
# There are supported Cloud Source Repository URLs in the following
# formats:
#
@@ -616,34 +562,88 @@
# `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", # The runtime in which to run the function. Required when deploying a new
+ "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+ "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If
+ # the function status is `DEPLOYING` or `DELETING`, then it points to the
+ # active operation.
+ "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.
+ },
+ "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
+ # given time.
+ "environmentVariables": { # Environment variables that shall be available during function execution.
+ "a_key": "A String",
+ },
+ "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
+ # by google.cloud.functions.v1beta2.GenerateUploadUrl
+ "timeout": "A String", # 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.
+ "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.
+ "service": "A String", # 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.
+ "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`
+ "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
+ # that only supports one instance per-project, this should be the name of the
+ # project (`projects/*`)
+ },
+ "status": "A String", # Output only. Status of the function deployment.
+ "availableMemoryMb": 42, # The amount of memory in MB available for a function.
+ # Defaults to 256MB.
+ "name": "A String", # A user-defined name of the function. Function names must be unique
+ # globally and match pattern `projects/*/locations/*/functions/*`
+ "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/*`
+ "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.
+ "serviceAccount": "A String", # The email of the function's service account. If empty, defaults to
+ # `{project_id}@appspot.gserviceaccount.com`.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(location, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(location, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Returns a list of functions that belong to the requested project.
Args:
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
+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. (required)
- pageSize: integer, Maximum number of functions to return per call.
pageToken: string, 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -653,52 +653,31 @@
An object of the form:
{ # Response for the `ListFunctions` method.
- "nextPageToken": "A String", # 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.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.
+ "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.
- "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
- # that only supports one instance per-project, this should be the name of the
- # project (`projects/*`)
- "service": "A String", # 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.
- "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`
+ "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
+ # archive which contains the function.
+ "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.
+ "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in
+ # https://source.developers.google.com domain are supported. The path should
+ # contain the name of the repository.
+ "tag": "A String", # The name of the tag that captures the state of the repository from
+ # which the function should be fetched.
+ "branch": "A String", # The name of the branch from which the function should be fetched.
+ "sourcePath": "A String", # The path within the repository where the function is defined. The path
+ # should point to the directory where Cloud Functions files are located. Use
+ # "/" if the function is defined directly in the root directory of a
+ # repository.
+ "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of
+ # function creation or update. For example when a user deployed from a
+ # branch, it will be the revision id of the latest change on this branch at
+ # that time. If user deployed from revision then this value will be always
+ # equal to the revision specified by the user.
+ "revision": "A String", # The id of the revision that captures the state of the repository from
+ # which the function should be fetched.
},
- "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
- "network": "A String", # The VPC Network that this cloud function can connect to. It can be
+ "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
@@ -712,33 +691,7 @@
#
# 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.
- "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in
- # https://source.developers.google.com domain are supported. The path should
- # contain the name of the repository.
- "sourcePath": "A String", # The path within the repository where the function is defined. The path
- # should point to the directory where Cloud Functions files are located. Use
- # "/" if the function is defined directly in the root directory of a
- # repository.
- "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of
- # function creation or update. For example when a user deployed from a
- # branch, it will be the revision id of the latest change on this branch at
- # that time. If user deployed from revision then this value will be always
- # equal to the revision specified by the user.
- "tag": "A String", # The name of the tag that captures the state of the repository from
- # which the function should be fetched.
- "branch": "A String", # The name of the branch from which the function should be fetched.
- "revision": "A String", # The id of the revision that captures the state of the repository from
- # which the function should be fetched.
- },
- "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
- # by google.cloud.functions.v1beta2.GenerateUploadUrl
- "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.
- },
- "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can
+ "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/*`
@@ -748,31 +701,16 @@
#
# 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`.
- "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
- # 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
+ "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
# backward compatibility, if function with given name is not found, then the
- # system will try to use function named "function".
+ # 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`.
- "timeout": "A String", # 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.
- "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If
- # the function status is `DEPLOYING` or `DELETING`, then it points to the
- # active operation.
- "sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined.
+ "labels": { # Labels associated with this Cloud Function.
+ "a_key": "A String",
+ },
+ "sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined.
# There are supported Cloud Source Repository URLs in the following
# formats:
#
@@ -785,17 +723,79 @@
# `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", # The runtime in which to run the function. Required when deploying a new
+ "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+ "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If
+ # the function status is `DEPLOYING` or `DELETING`, then it points to the
+ # active operation.
+ "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.
+ },
+ "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
+ # given time.
+ "environmentVariables": { # Environment variables that shall be available during function execution.
+ "a_key": "A String",
+ },
+ "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
+ # by google.cloud.functions.v1beta2.GenerateUploadUrl
+ "timeout": "A String", # 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.
+ "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.
+ "service": "A String", # 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.
+ "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`
+ "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
+ # that only supports one instance per-project, this should be the name of the
+ # project (`projects/*`)
+ },
+ "status": "A String", # Output only. Status of the function deployment.
+ "availableMemoryMb": 42, # The amount of memory in MB available for a function.
+ # Defaults to 256MB.
+ "name": "A String", # A user-defined name of the function. Function names must be unique
+ # globally and match pattern `projects/*/locations/*/functions/*`
+ "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/*`
+ "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.
+ "serviceAccount": "A String", # The email of the function's service account. If empty, defaults to
+ # `{project_id}@appspot.gserviceaccount.com`.
},
],
+ "nextPageToken": "A String", # 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.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",
+ ],
}</pre>
</div>
@@ -808,7 +808,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -824,41 +824,28 @@
{ # 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.
- "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
- # that only supports one instance per-project, this should be the name of the
- # project (`projects/*`)
- "service": "A String", # 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.
- "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`
+ "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
+ # archive which contains the function.
+ "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.
+ "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in
+ # https://source.developers.google.com domain are supported. The path should
+ # contain the name of the repository.
+ "tag": "A String", # The name of the tag that captures the state of the repository from
+ # which the function should be fetched.
+ "branch": "A String", # The name of the branch from which the function should be fetched.
+ "sourcePath": "A String", # The path within the repository where the function is defined. The path
+ # should point to the directory where Cloud Functions files are located. Use
+ # "/" if the function is defined directly in the root directory of a
+ # repository.
+ "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of
+ # function creation or update. For example when a user deployed from a
+ # branch, it will be the revision id of the latest change on this branch at
+ # that time. If user deployed from revision then this value will be always
+ # equal to the revision specified by the user.
+ "revision": "A String", # The id of the revision that captures the state of the repository from
+ # which the function should be fetched.
},
- "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
- "network": "A String", # The VPC Network that this cloud function can connect to. It can be
+ "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
@@ -872,33 +859,7 @@
#
# 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.
- "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in
- # https://source.developers.google.com domain are supported. The path should
- # contain the name of the repository.
- "sourcePath": "A String", # The path within the repository where the function is defined. The path
- # should point to the directory where Cloud Functions files are located. Use
- # "/" if the function is defined directly in the root directory of a
- # repository.
- "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of
- # function creation or update. For example when a user deployed from a
- # branch, it will be the revision id of the latest change on this branch at
- # that time. If user deployed from revision then this value will be always
- # equal to the revision specified by the user.
- "tag": "A String", # The name of the tag that captures the state of the repository from
- # which the function should be fetched.
- "branch": "A String", # The name of the branch from which the function should be fetched.
- "revision": "A String", # The id of the revision that captures the state of the repository from
- # which the function should be fetched.
- },
- "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
- # by google.cloud.functions.v1beta2.GenerateUploadUrl
- "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.
- },
- "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can
+ "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/*`
@@ -908,31 +869,16 @@
#
# 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`.
- "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
- # 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
+ "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
# backward compatibility, if function with given name is not found, then the
- # system will try to use function named "function".
+ # 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`.
- "timeout": "A String", # 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.
- "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If
- # the function status is `DEPLOYING` or `DELETING`, then it points to the
- # active operation.
- "sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined.
+ "labels": { # Labels associated with this Cloud Function.
+ "a_key": "A String",
+ },
+ "sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined.
# There are supported Cloud Source Repository URLs in the following
# formats:
#
@@ -945,15 +891,69 @@
# `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", # The runtime in which to run the function. Required when deploying a new
+ "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+ "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If
+ # the function status is `DEPLOYING` or `DELETING`, then it points to the
+ # active operation.
+ "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.
+ },
+ "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
+ # given time.
+ "environmentVariables": { # Environment variables that shall be available during function execution.
+ "a_key": "A String",
+ },
+ "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
+ # by google.cloud.functions.v1beta2.GenerateUploadUrl
+ "timeout": "A String", # 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.
+ "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.
+ "service": "A String", # 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.
+ "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`
+ "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
+ # that only supports one instance per-project, this should be the name of the
+ # project (`projects/*`)
+ },
+ "status": "A String", # Output only. Status of the function deployment.
+ "availableMemoryMb": 42, # The amount of memory in MB available for a function.
+ # Defaults to 256MB.
+ "name": "A String", # A user-defined name of the function. Function names must be unique
+ # globally and match pattern `projects/*/locations/*/functions/*`
+ "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/*`
+ "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.
+ "serviceAccount": "A String", # The email of the function's service account. If empty, defaults to
+ # `{project_id}@appspot.gserviceaccount.com`.
}
x__xgafv: string, V1 error format.
@@ -966,34 +966,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # 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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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). 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).
- "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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "done": True or False, # 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.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # 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
@@ -1001,11 +977,35 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # 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}`.
+ "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). 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).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "metadata": { # 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>