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/cloudshell_v1alpha1.users.environments.html b/docs/dyn/cloudshell_v1alpha1.users.environments.html
index 26b37cd..d425a7d 100644
--- a/docs/dyn/cloudshell_v1alpha1.users.environments.html
+++ b/docs/dyn/cloudshell_v1alpha1.users.environments.html
@@ -107,10 +107,10 @@
The object takes the form of:
{ # Request message for AuthorizeEnvironment.
- "expireTime": "A String", # The time when the credentials expire. If not set, defaults to one hour from
+ "expireTime": "A String", # The time when the credentials expire. If not set, defaults to one hour from
# when the server received the request.
- "idToken": "A String", # The OAuth ID token that should be sent to the environment.
- "accessToken": "A String", # The OAuth access token that should be sent to the environment.
+ "accessToken": "A String", # The OAuth access token that should be sent to the environment.
+ "idToken": "A String", # The OAuth ID token that should be sent to the environment.
}
x__xgafv: string, V1 error format.
@@ -149,53 +149,53 @@
An object of the form:
{ # A Cloud Shell environment, which is defined as the combination of a Docker
- # image specifying what is installed on the environment and a home directory
- # containing the user's data that will remain across sessions. Each user has a
- # single environment with the ID "default".
- "name": "A String", # Output only. Full name of this resource, in the format
- # `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the
- # email address of the user to whom this environment belongs, and
- # `{environment_id}` is the identifier of this environment. For example,
- # `users/someone@example.com/environments/default`.
- "webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS
- # connections with the environment.
- "vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default
- # VM size.
- "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g.
- # "gcr.io/dev-con/cloud-devshell:latest".
- "publicKeys": [ # Output only. Public keys associated with the environment. Clients can
- # connect to this environment via SSH only if they possess a private key
- # corresponding to at least one of these public keys. Keys can be added to or
- # removed from the environment using the CreatePublicKey and DeletePublicKey
- # methods.
- { # A public SSH key, corresponding to a private SSH key held by the client.
- "name": "A String", # Output only. Full name of this resource, in the format
- # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.
- # `{owner_email}` is the email address of the user to whom the key belongs.
- # `{environment_id}` is the identifier of the environment to which the key
- # grants access. `{key_id}` is the unique identifier of the key. For example,
- # `users/someone@example.com/environments/default/publicKeys/myKey`.
- "key": "A String", # Required. Content of this key.
- "format": "A String", # Required. Format of this key's content.
- },
- ],
- "state": "A String", # Output only. Current execution state of this environment.
- "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions
- # with the environment.
- "sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions
- # with the environment.
- "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions
- # with the environment.
- "webPorts": [ # Output only. Ports to which clients can connect to initiate HTTPS or WSS
- # connections with the environment.
- 42,
- ],
- "id": "A String", # Output only. The environment's identifier, unique among the user's
- # environments.
- "size": "A String", # Indicates the size of the backing VM running the environment. If set to
- # something other than DEFAULT, it will be reverted to the default VM size
- # after vm_size_expire_time.
- }</pre>
+ # image specifying what is installed on the environment and a home directory
+ # containing the user's data that will remain across sessions. Each user has a
+ # single environment with the ID "default".
+ "state": "A String", # Output only. Current execution state of this environment.
+ "name": "A String", # Output only. Full name of this resource, in the format
+ # `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the
+ # email address of the user to whom this environment belongs, and
+ # `{environment_id}` is the identifier of this environment. For example,
+ # `users/someone@example.com/environments/default`.
+ "vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default
+ # VM size.
+ "id": "A String", # Output only. The environment's identifier, unique among the user's
+ # environments.
+ "size": "A String", # Indicates the size of the backing VM running the environment. If set to
+ # something other than DEFAULT, it will be reverted to the default VM size
+ # after vm_size_expire_time.
+ "webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS
+ # connections with the environment.
+ "publicKeys": [ # Output only. Public keys associated with the environment. Clients can
+ # connect to this environment via SSH only if they possess a private key
+ # corresponding to at least one of these public keys. Keys can be added to or
+ # removed from the environment using the CreatePublicKey and DeletePublicKey
+ # methods.
+ { # A public SSH key, corresponding to a private SSH key held by the client.
+ "name": "A String", # Output only. Full name of this resource, in the format
+ # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.
+ # `{owner_email}` is the email address of the user to whom the key belongs.
+ # `{environment_id}` is the identifier of the environment to which the key
+ # grants access. `{key_id}` is the unique identifier of the key. For example,
+ # `users/someone@example.com/environments/default/publicKeys/myKey`.
+ "key": "A String", # Required. Content of this key.
+ "format": "A String", # Required. Format of this key's content.
+ },
+ ],
+ "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g.
+ # "gcr.io/dev-con/cloud-devshell:latest".
+ "webPorts": [ # Output only. Ports to which clients can connect to initiate HTTPS or WSS
+ # connections with the environment.
+ 42,
+ ],
+ "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions
+ # with the environment.
+ "sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions
+ # with the environment.
+ "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions
+ # with the environment.
+ }</pre>
</div>
<div class="method">
@@ -210,53 +210,53 @@
The object takes the form of:
{ # A Cloud Shell environment, which is defined as the combination of a Docker
- # image specifying what is installed on the environment and a home directory
- # containing the user's data that will remain across sessions. Each user has a
- # single environment with the ID "default".
- "name": "A String", # Output only. Full name of this resource, in the format
- # `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the
- # email address of the user to whom this environment belongs, and
- # `{environment_id}` is the identifier of this environment. For example,
- # `users/someone@example.com/environments/default`.
- "webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS
- # connections with the environment.
- "vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default
- # VM size.
- "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g.
- # "gcr.io/dev-con/cloud-devshell:latest".
- "publicKeys": [ # Output only. Public keys associated with the environment. Clients can
- # connect to this environment via SSH only if they possess a private key
- # corresponding to at least one of these public keys. Keys can be added to or
- # removed from the environment using the CreatePublicKey and DeletePublicKey
- # methods.
- { # A public SSH key, corresponding to a private SSH key held by the client.
- "name": "A String", # Output only. Full name of this resource, in the format
- # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.
- # `{owner_email}` is the email address of the user to whom the key belongs.
- # `{environment_id}` is the identifier of the environment to which the key
- # grants access. `{key_id}` is the unique identifier of the key. For example,
- # `users/someone@example.com/environments/default/publicKeys/myKey`.
- "key": "A String", # Required. Content of this key.
- "format": "A String", # Required. Format of this key's content.
- },
- ],
- "state": "A String", # Output only. Current execution state of this environment.
- "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions
- # with the environment.
- "sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions
- # with the environment.
- "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions
- # with the environment.
- "webPorts": [ # Output only. Ports to which clients can connect to initiate HTTPS or WSS
- # connections with the environment.
- 42,
- ],
- "id": "A String", # Output only. The environment's identifier, unique among the user's
- # environments.
- "size": "A String", # Indicates the size of the backing VM running the environment. If set to
- # something other than DEFAULT, it will be reverted to the default VM size
- # after vm_size_expire_time.
- }
+ # image specifying what is installed on the environment and a home directory
+ # containing the user's data that will remain across sessions. Each user has a
+ # single environment with the ID "default".
+ "state": "A String", # Output only. Current execution state of this environment.
+ "name": "A String", # Output only. Full name of this resource, in the format
+ # `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the
+ # email address of the user to whom this environment belongs, and
+ # `{environment_id}` is the identifier of this environment. For example,
+ # `users/someone@example.com/environments/default`.
+ "vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default
+ # VM size.
+ "id": "A String", # Output only. The environment's identifier, unique among the user's
+ # environments.
+ "size": "A String", # Indicates the size of the backing VM running the environment. If set to
+ # something other than DEFAULT, it will be reverted to the default VM size
+ # after vm_size_expire_time.
+ "webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS
+ # connections with the environment.
+ "publicKeys": [ # Output only. Public keys associated with the environment. Clients can
+ # connect to this environment via SSH only if they possess a private key
+ # corresponding to at least one of these public keys. Keys can be added to or
+ # removed from the environment using the CreatePublicKey and DeletePublicKey
+ # methods.
+ { # A public SSH key, corresponding to a private SSH key held by the client.
+ "name": "A String", # Output only. Full name of this resource, in the format
+ # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.
+ # `{owner_email}` is the email address of the user to whom the key belongs.
+ # `{environment_id}` is the identifier of the environment to which the key
+ # grants access. `{key_id}` is the unique identifier of the key. For example,
+ # `users/someone@example.com/environments/default/publicKeys/myKey`.
+ "key": "A String", # Required. Content of this key.
+ "format": "A String", # Required. Format of this key's content.
+ },
+ ],
+ "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g.
+ # "gcr.io/dev-con/cloud-devshell:latest".
+ "webPorts": [ # Output only. Ports to which clients can connect to initiate HTTPS or WSS
+ # connections with the environment.
+ 42,
+ ],
+ "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions
+ # with the environment.
+ "sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions
+ # with the environment.
+ "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions
+ # with the environment.
+}
updateMask: string, Mask specifying which fields in the environment should be updated.
x__xgafv: string, V1 error format.
@@ -268,53 +268,53 @@
An object of the form:
{ # A Cloud Shell environment, which is defined as the combination of a Docker
- # image specifying what is installed on the environment and a home directory
- # containing the user's data that will remain across sessions. Each user has a
- # single environment with the ID "default".
- "name": "A String", # Output only. Full name of this resource, in the format
- # `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the
- # email address of the user to whom this environment belongs, and
- # `{environment_id}` is the identifier of this environment. For example,
- # `users/someone@example.com/environments/default`.
- "webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS
- # connections with the environment.
- "vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default
- # VM size.
- "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g.
- # "gcr.io/dev-con/cloud-devshell:latest".
- "publicKeys": [ # Output only. Public keys associated with the environment. Clients can
- # connect to this environment via SSH only if they possess a private key
- # corresponding to at least one of these public keys. Keys can be added to or
- # removed from the environment using the CreatePublicKey and DeletePublicKey
- # methods.
- { # A public SSH key, corresponding to a private SSH key held by the client.
- "name": "A String", # Output only. Full name of this resource, in the format
- # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.
- # `{owner_email}` is the email address of the user to whom the key belongs.
- # `{environment_id}` is the identifier of the environment to which the key
- # grants access. `{key_id}` is the unique identifier of the key. For example,
- # `users/someone@example.com/environments/default/publicKeys/myKey`.
- "key": "A String", # Required. Content of this key.
- "format": "A String", # Required. Format of this key's content.
- },
- ],
- "state": "A String", # Output only. Current execution state of this environment.
- "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions
- # with the environment.
- "sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions
- # with the environment.
- "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions
- # with the environment.
- "webPorts": [ # Output only. Ports to which clients can connect to initiate HTTPS or WSS
- # connections with the environment.
- 42,
- ],
- "id": "A String", # Output only. The environment's identifier, unique among the user's
- # environments.
- "size": "A String", # Indicates the size of the backing VM running the environment. If set to
- # something other than DEFAULT, it will be reverted to the default VM size
- # after vm_size_expire_time.
- }</pre>
+ # image specifying what is installed on the environment and a home directory
+ # containing the user's data that will remain across sessions. Each user has a
+ # single environment with the ID "default".
+ "state": "A String", # Output only. Current execution state of this environment.
+ "name": "A String", # Output only. Full name of this resource, in the format
+ # `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the
+ # email address of the user to whom this environment belongs, and
+ # `{environment_id}` is the identifier of this environment. For example,
+ # `users/someone@example.com/environments/default`.
+ "vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default
+ # VM size.
+ "id": "A String", # Output only. The environment's identifier, unique among the user's
+ # environments.
+ "size": "A String", # Indicates the size of the backing VM running the environment. If set to
+ # something other than DEFAULT, it will be reverted to the default VM size
+ # after vm_size_expire_time.
+ "webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS
+ # connections with the environment.
+ "publicKeys": [ # Output only. Public keys associated with the environment. Clients can
+ # connect to this environment via SSH only if they possess a private key
+ # corresponding to at least one of these public keys. Keys can be added to or
+ # removed from the environment using the CreatePublicKey and DeletePublicKey
+ # methods.
+ { # A public SSH key, corresponding to a private SSH key held by the client.
+ "name": "A String", # Output only. Full name of this resource, in the format
+ # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.
+ # `{owner_email}` is the email address of the user to whom the key belongs.
+ # `{environment_id}` is the identifier of the environment to which the key
+ # grants access. `{key_id}` is the unique identifier of the key. For example,
+ # `users/someone@example.com/environments/default/publicKeys/myKey`.
+ "key": "A String", # Required. Content of this key.
+ "format": "A String", # Required. Format of this key's content.
+ },
+ ],
+ "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g.
+ # "gcr.io/dev-con/cloud-devshell:latest".
+ "webPorts": [ # Output only. Ports to which clients can connect to initiate HTTPS or WSS
+ # connections with the environment.
+ 42,
+ ],
+ "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions
+ # with the environment.
+ "sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions
+ # with the environment.
+ "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions
+ # with the environment.
+ }</pre>
</div>
<div class="method">
@@ -334,10 +334,22 @@
The object takes the form of:
{ # Request message for StartEnvironment.
- "accessToken": "A String", # The initial access token passed to the environment. If this is present and
+ "accessToken": "A String", # The initial access token passed to the environment. If this is present and
# valid, the environment will be pre-authenticated with gcloud so that the
# user can run gcloud commands in Cloud Shell without having to log in. This
# code can be updated later by calling AuthorizeEnvironment.
+ "publicKeys": [ # Public keys that should be added to the environment before it is started.
+ { # A public SSH key, corresponding to a private SSH key held by the client.
+ "name": "A String", # Output only. Full name of this resource, in the format
+ # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.
+ # `{owner_email}` is the email address of the user to whom the key belongs.
+ # `{environment_id}` is the identifier of the environment to which the key
+ # grants access. `{key_id}` is the unique identifier of the key. For example,
+ # `users/someone@example.com/environments/default/publicKeys/myKey`.
+ "key": "A String", # Required. Content of this key.
+ "format": "A String", # Required. Format of this key's content.
+ },
+ ],
}
x__xgafv: string, V1 error format.
@@ -350,16 +362,34 @@
{ # 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
+ "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.
+ "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
@@ -367,29 +397,11 @@
# 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).
- "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.
- },
- ],
- },
}</pre>
</div>