docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html b/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html
index 9e1d5a8..4a8d92b 100644
--- a/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html
+++ b/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html
@@ -149,27 +149,77 @@
{ # Describes a Cloud Function that contains user computation executed in
# response to an event. It encapsulate function and triggers configurations.
+ "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",
+ },
+ "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`
+ "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.
+ "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.
+ },
+ },
+ },
+ "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.
+ "availableMemoryMb": 42, # The amount of memory in MB available for a function.
+ # Defaults to 256MB.
+ "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).
+ "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`.
"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.
- },
+ "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.
"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
@@ -184,25 +234,34 @@
#
# See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
# more information on connecting Cloud projects.
- "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.
+ "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.
+ "revision": "A String", # The id of the revision that captures the state of the repository from
+ # which the function should be fetched.
+ "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.
+ "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.
+ "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.
+ },
+ "labels": { # Labels associated with this Cloud Function.
+ "a_key": "A String",
+ },
"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".
# For Node.js this is name of a function exported by the module specified
# in `source_location`.
- "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:
@@ -220,65 +279,6 @@
"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).
- "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,6 +291,12 @@
{ # 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.
+ },
"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.
@@ -314,7 +320,6 @@
#
# 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.
@@ -324,12 +329,7 @@
"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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
}</pre>
</div>
@@ -352,6 +352,12 @@
{ # 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.
+ },
"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.
@@ -375,7 +381,6 @@
#
# 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.
@@ -385,12 +390,7 @@
"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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
}</pre>
</div>
@@ -495,27 +495,77 @@
{ # Describes a Cloud Function that contains user computation executed in
# response to an event. It encapsulate function and triggers configurations.
+ "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",
+ },
+ "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`
+ "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.
+ "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.
+ },
+ },
+ },
+ "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.
+ "availableMemoryMb": 42, # The amount of memory in MB available for a function.
+ # Defaults to 256MB.
+ "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).
+ "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`.
"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.
- },
+ "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.
"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
@@ -530,25 +580,34 @@
#
# See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
# more information on connecting Cloud projects.
- "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.
+ "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.
+ "revision": "A String", # The id of the revision that captures the state of the repository from
+ # which the function should be fetched.
+ "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.
+ "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.
+ "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.
+ },
+ "labels": { # Labels associated with this Cloud Function.
+ "a_key": "A String",
+ },
"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".
# For Node.js this is name of a function exported by the module specified
# in `source_location`.
- "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:
@@ -566,65 +625,6 @@
"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).
- "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>
@@ -653,30 +653,84 @@
An object of the form:
{ # Response for the `ListFunctions` method.
+ "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.
+ "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",
+ },
+ "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`
+ "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.
+ "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.
+ },
+ },
+ },
+ "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.
+ "availableMemoryMb": 42, # The amount of memory in MB available for a function.
+ # Defaults to 256MB.
+ "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).
+ "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`.
"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.
- },
+ "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.
"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
@@ -691,25 +745,34 @@
#
# See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
# more information on connecting Cloud projects.
- "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.
+ "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.
+ "revision": "A String", # The id of the revision that captures the state of the repository from
+ # which the function should be fetched.
+ "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.
+ "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.
+ "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.
+ },
+ "labels": { # Labels associated with this Cloud Function.
+ "a_key": "A String",
+ },
"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".
# For Node.js this is name of a function exported by the module specified
# in `source_location`.
- "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:
@@ -727,75 +790,12 @@
"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).
- "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>
@@ -824,27 +824,77 @@
{ # Describes a Cloud Function that contains user computation executed in
# response to an event. It encapsulate function and triggers configurations.
+ "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",
+ },
+ "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`
+ "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.
+ "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.
+ },
+ },
+ },
+ "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.
+ "availableMemoryMb": 42, # The amount of memory in MB available for a function.
+ # Defaults to 256MB.
+ "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).
+ "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`.
"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.
- },
+ "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.
"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
@@ -859,25 +909,34 @@
#
# See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
# more information on connecting Cloud projects.
- "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.
+ "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.
+ "revision": "A String", # The id of the revision that captures the state of the repository from
+ # which the function should be fetched.
+ "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.
+ "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.
+ "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.
+ },
+ "labels": { # Labels associated with this Cloud Function.
+ "a_key": "A String",
+ },
"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".
# For Node.js this is name of a function exported by the module specified
# in `source_location`.
- "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:
@@ -895,65 +954,6 @@
"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).
- "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,6 +966,12 @@
{ # 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.
+ },
"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.
@@ -989,7 +995,6 @@
#
# 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.
@@ -999,12 +1004,7 @@
"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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
}</pre>
</div>