docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/cloudshell_v1alpha1.users.environments.html b/docs/dyn/cloudshell_v1alpha1.users.environments.html
index 7f5265b..1d3b1cd 100644
--- a/docs/dyn/cloudshell_v1alpha1.users.environments.html
+++ b/docs/dyn/cloudshell_v1alpha1.users.environments.html
@@ -106,8 +106,8 @@
{ # Request message for AuthorizeEnvironment.
"accessToken": "A String", # The OAuth access token that should be sent to the environment.
- "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.
+ "expireTime": "A String", # The time when the credentials expire. If not set, defaults to one hour from when the server received the request.
}
x__xgafv: string, V1 error format.
@@ -142,26 +142,26 @@
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".
- "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions with the environment.
- "state": "A String", # Output only. Current execution state of this 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`.
- "format": "A String", # Required. Format of this key's content.
- "key": "A String", # Required. Content of this key.
- },
- ],
- "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions with the environment.
- "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.
- "id": "A String", # Output only. The environment's identifier, unique among the user's environments.
- "vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default VM size.
"sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions with the environment.
- "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
- "webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the 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`.
+ "state": "A String", # Output only. Current execution state of this 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.
+ "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions with the environment.
+ "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.
+ "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
+ "webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.
+ "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions with the 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.
+ "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.
+ "key": "A String", # Required. Content of this key.
+ "format": "A String", # Required. Format of this key's content.
+ "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`.
+ },
+ ],
}</pre>
</div>
@@ -175,26 +175,26 @@
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".
- "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions with the environment.
- "state": "A String", # Output only. Current execution state of this 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`.
- "format": "A String", # Required. Format of this key's content.
- "key": "A String", # Required. Content of this key.
- },
- ],
- "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions with the environment.
- "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.
- "id": "A String", # Output only. The environment's identifier, unique among the user's environments.
- "vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default VM size.
"sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions with the environment.
- "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
- "webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the 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`.
+ "state": "A String", # Output only. Current execution state of this 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.
+ "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions with the environment.
+ "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.
+ "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
+ "webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.
+ "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions with the 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.
+ "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.
+ "key": "A String", # Required. Content of this key.
+ "format": "A String", # Required. Format of this key's content.
+ "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`.
+ },
+ ],
}
updateMask: string, Mask specifying which fields in the environment should be updated.
@@ -207,26 +207,26 @@
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".
- "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions with the environment.
- "state": "A String", # Output only. Current execution state of this 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`.
- "format": "A String", # Required. Format of this key's content.
- "key": "A String", # Required. Content of this key.
- },
- ],
- "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions with the environment.
- "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.
- "id": "A String", # Output only. The environment's identifier, unique among the user's environments.
- "vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default VM size.
"sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions with the environment.
- "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
- "webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the 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`.
+ "state": "A String", # Output only. Current execution state of this 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.
+ "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions with the environment.
+ "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.
+ "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
+ "webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.
+ "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions with the 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.
+ "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.
+ "key": "A String", # Required. Content of this key.
+ "format": "A String", # Required. Format of this key's content.
+ "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`.
+ },
+ ],
}</pre>
</div>
@@ -240,14 +240,14 @@
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 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`.
- "format": "A String", # Required. Format of this key's content.
"key": "A String", # Required. Content of this key.
+ "format": "A String", # Required. Format of this key's content.
+ "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`.
},
],
- "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.
}
x__xgafv: string, V1 error format.
@@ -259,23 +259,23 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "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 methods, the response should have the type `XxxResponse`, where `Xxx` 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.
- },
"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.
- "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}`.
- "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 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). # The error result of the operation in case of failure or cancellation.
- "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.
},
],
+ "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.
},
+ "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.
+ },
+ "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 methods, the response should have the type `XxxResponse`, where `Xxx` 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.
+ },
+ "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}`.
}</pre>
</div>