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/remotebuildexecution_v1alpha.projects.instances.html b/docs/dyn/remotebuildexecution_v1alpha.projects.instances.html
index 122e34a..a6082dd 100644
--- a/docs/dyn/remotebuildexecution_v1alpha.projects.instances.html
+++ b/docs/dyn/remotebuildexecution_v1alpha.projects.instances.html
@@ -106,29 +106,29 @@
The object takes the form of:
{ # The request used for `CreateInstance`.
- "instanceId": "A String", # ID of the created instance.
+ "parent": "A String", # Resource name of the project containing the instance.
+ # Format: `projects/[PROJECT_ID]`.
+ "instanceId": "A String", # ID of the created instance.
# A valid `instance_id` must:
# be 6-50 characters long,
# contain only lowercase letters, digits, hyphens and underscores,
# start with a lowercase letter, and
# end with a lowercase letter or a digit.
- "instance": { # Instance conceptually encapsulates all Remote Build Execution resources # Specifies the instance to create.
+ "instance": { # Instance conceptually encapsulates all Remote Build Execution resources # Specifies the instance to create.
# The name in the instance, if specified in the instance, is ignored.
# for remote builds.
# An instance consists of storage and compute resources (for example,
# `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for
# running remote builds.
# All Remote Build Execution API calls are scoped to an instance.
- "loggingEnabled": True or False, # Output only. Whether stack driver logging is enabled for the instance.
- "state": "A String", # Output only. State of the instance.
- "location": "A String", # The location is a GCP region. Currently only `us-central1` is supported.
- "name": "A String", # Output only. Instance resource name formatted as:
+ "location": "A String", # The location is a GCP region. Currently only `us-central1` is supported.
+ "state": "A String", # Output only. State of the instance.
+ "loggingEnabled": True or False, # Output only. Whether stack driver logging is enabled for the instance.
+ "name": "A String", # Output only. Instance resource name formatted as:
# `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.
# Name should not be populated when creating an instance since it is provided
# in the `instance_id` field.
},
- "parent": "A String", # Resource name of the project containing the instance.
- # Format: `projects/[PROJECT_ID]`.
}
x__xgafv: string, V1 error format.
@@ -141,28 +141,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -170,16 +152,34 @@
# 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}`.
- "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.
},
}</pre>
</div>
@@ -205,28 +205,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -234,16 +216,34 @@
# 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}`.
- "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.
},
}</pre>
</div>
@@ -269,10 +269,10 @@
# `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for
# running remote builds.
# All Remote Build Execution API calls are scoped to an instance.
- "loggingEnabled": True or False, # Output only. Whether stack driver logging is enabled for the instance.
- "state": "A String", # Output only. State of the instance.
- "location": "A String", # The location is a GCP region. Currently only `us-central1` is supported.
- "name": "A String", # Output only. Instance resource name formatted as:
+ "location": "A String", # The location is a GCP region. Currently only `us-central1` is supported.
+ "state": "A String", # Output only. State of the instance.
+ "loggingEnabled": True or False, # Output only. Whether stack driver logging is enabled for the instance.
+ "name": "A String", # Output only. Instance resource name formatted as:
# `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.
# Name should not be populated when creating an instance since it is provided
# in the `instance_id` field.
@@ -295,17 +295,17 @@
An object of the form:
{
- "instances": [ # The list of instances in a given project.
+ "instances": [ # The list of instances in a given project.
{ # Instance conceptually encapsulates all Remote Build Execution resources
# for remote builds.
# An instance consists of storage and compute resources (for example,
# `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for
# running remote builds.
# All Remote Build Execution API calls are scoped to an instance.
- "loggingEnabled": True or False, # Output only. Whether stack driver logging is enabled for the instance.
- "state": "A String", # Output only. State of the instance.
- "location": "A String", # The location is a GCP region. Currently only `us-central1` is supported.
- "name": "A String", # Output only. Instance resource name formatted as:
+ "location": "A String", # The location is a GCP region. Currently only `us-central1` is supported.
+ "state": "A String", # Output only. State of the instance.
+ "loggingEnabled": True or False, # Output only. Whether stack driver logging is enabled for the instance.
+ "name": "A String", # Output only. Instance resource name formatted as:
# `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.
# Name should not be populated when creating an instance since it is provided
# in the `instance_id` field.