Clean and regen docs (#401)
diff --git a/docs/dyn/dataproc_v1alpha1.projects.regions.clusters.html b/docs/dyn/dataproc_v1alpha1.projects.regions.clusters.html
index 33e337d..0d03dbb 100644
--- a/docs/dyn/dataproc_v1alpha1.projects.regions.clusters.html
+++ b/docs/dyn/dataproc_v1alpha1.projects.regions.clusters.html
@@ -110,28 +110,6 @@
"substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
- "statusHistory": [ # Output-only Previous cluster statuses.
- { # The status of a cluster and its instances.
- "state": "A String", # The cluster's state.
- "stateStartTime": "A String", # Time when this state was entered.
- "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
- "detail": "A String", # Optional details of cluster's state.
- },
- ],
- "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
- "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
- "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
- "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
- "a_key": "A String",
- },
- "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
- "yarnMetrics": { # The YARN metrics.
- "a_key": "A String",
- },
- "hdfsMetrics": { # The HDFS metrics.
- "a_key": "A String",
- },
- },
"configuration": { # The cluster configuration. # Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
"workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
@@ -146,7 +124,29 @@
"workers": [ # Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
- "numWorkers": 42, # Deprecated The number of worker nodes in the cluster.
+ "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
+ { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
+ "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
+ "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
+ },
+ ],
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
+ },
+ },
"gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Optional The shared Google Compute Engine configuration settings for all instances in a cluster.
"internalIpOnly": True or False, # If true, all instances in the cluser will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
"networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: compute.googleapis.com/projects/[project_id]/regions/global/default.
@@ -180,29 +180,7 @@
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
- "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
- "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
- "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
- "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
- "A String",
- ],
- "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
- "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
- { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
- "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
- "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
- },
- ],
- "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
- "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
- "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
- "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
- },
- "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
- "instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
- "instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
- },
- },
+ "numWorkers": 42, # Deprecated The number of worker nodes in the cluster.
"initializationActions": [ # Optional Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below:
# ROLE=$(/usr/share/google/get_metadata_value attributes/role)
# if [[ "${ROLE}" == 'Master' ]]; then
@@ -262,6 +240,28 @@
},
},
},
+ "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
+ "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
+ "a_key": "A String",
+ },
+ "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
+ "yarnMetrics": { # The YARN metrics.
+ "a_key": "A String",
+ },
+ "hdfsMetrics": { # The HDFS metrics.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # Output-only Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
"createTime": "A String", # Output-only The timestamp of cluster creation.
}
@@ -279,9 +279,9 @@
},
"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). The error model is designed to be: # The error result of the operation in case of failure.
# Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
+ # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
# Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
- # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
+ # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
# Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
# Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
# Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
@@ -323,9 +323,9 @@
},
"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). The error model is designed to be: # The error result of the operation in case of failure.
# Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
+ # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
# Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
- # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
+ # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
# Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
# Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
# Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
@@ -368,28 +368,6 @@
"substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
- "statusHistory": [ # Output-only Previous cluster statuses.
- { # The status of a cluster and its instances.
- "state": "A String", # The cluster's state.
- "stateStartTime": "A String", # Time when this state was entered.
- "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
- "detail": "A String", # Optional details of cluster's state.
- },
- ],
- "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
- "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
- "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
- "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
- "a_key": "A String",
- },
- "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
- "yarnMetrics": { # The YARN metrics.
- "a_key": "A String",
- },
- "hdfsMetrics": { # The HDFS metrics.
- "a_key": "A String",
- },
- },
"configuration": { # The cluster configuration. # Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
"workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
@@ -404,7 +382,29 @@
"workers": [ # Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
- "numWorkers": 42, # Deprecated The number of worker nodes in the cluster.
+ "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
+ { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
+ "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
+ "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
+ },
+ ],
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
+ },
+ },
"gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Optional The shared Google Compute Engine configuration settings for all instances in a cluster.
"internalIpOnly": True or False, # If true, all instances in the cluser will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
"networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: compute.googleapis.com/projects/[project_id]/regions/global/default.
@@ -438,29 +438,7 @@
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
- "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
- "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
- "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
- "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
- "A String",
- ],
- "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
- "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
- { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
- "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
- "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
- },
- ],
- "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
- "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
- "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
- "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
- },
- "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
- "instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
- "instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
- },
- },
+ "numWorkers": 42, # Deprecated The number of worker nodes in the cluster.
"initializationActions": [ # Optional Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below:
# ROLE=$(/usr/share/google/get_metadata_value attributes/role)
# if [[ "${ROLE}" == 'Master' ]]; then
@@ -520,6 +498,28 @@
},
},
},
+ "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
+ "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
+ "a_key": "A String",
+ },
+ "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
+ "yarnMetrics": { # The YARN metrics.
+ "a_key": "A String",
+ },
+ "hdfsMetrics": { # The HDFS metrics.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # Output-only Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
"createTime": "A String", # Output-only The timestamp of cluster creation.
}</pre>
</div>
@@ -552,28 +552,6 @@
"substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
- "statusHistory": [ # Output-only Previous cluster statuses.
- { # The status of a cluster and its instances.
- "state": "A String", # The cluster's state.
- "stateStartTime": "A String", # Time when this state was entered.
- "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
- "detail": "A String", # Optional details of cluster's state.
- },
- ],
- "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
- "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
- "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
- "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
- "a_key": "A String",
- },
- "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
- "yarnMetrics": { # The YARN metrics.
- "a_key": "A String",
- },
- "hdfsMetrics": { # The HDFS metrics.
- "a_key": "A String",
- },
- },
"configuration": { # The cluster configuration. # Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
"workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
@@ -588,7 +566,29 @@
"workers": [ # Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
- "numWorkers": 42, # Deprecated The number of worker nodes in the cluster.
+ "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
+ { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
+ "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
+ "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
+ },
+ ],
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
+ },
+ },
"gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Optional The shared Google Compute Engine configuration settings for all instances in a cluster.
"internalIpOnly": True or False, # If true, all instances in the cluser will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
"networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: compute.googleapis.com/projects/[project_id]/regions/global/default.
@@ -622,29 +622,7 @@
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
- "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
- "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
- "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
- "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
- "A String",
- ],
- "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
- "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
- { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
- "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
- "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
- },
- ],
- "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
- "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
- "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
- "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
- },
- "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
- "instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
- "instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
- },
- },
+ "numWorkers": 42, # Deprecated The number of worker nodes in the cluster.
"initializationActions": [ # Optional Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below:
# ROLE=$(/usr/share/google/get_metadata_value attributes/role)
# if [[ "${ROLE}" == 'Master' ]]; then
@@ -704,6 +682,28 @@
},
},
},
+ "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
+ "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
+ "a_key": "A String",
+ },
+ "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
+ "yarnMetrics": { # The YARN metrics.
+ "a_key": "A String",
+ },
+ "hdfsMetrics": { # The HDFS metrics.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # Output-only Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
"createTime": "A String", # Output-only The timestamp of cluster creation.
},
],
@@ -742,28 +742,6 @@
"substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
- "statusHistory": [ # Output-only Previous cluster statuses.
- { # The status of a cluster and its instances.
- "state": "A String", # The cluster's state.
- "stateStartTime": "A String", # Time when this state was entered.
- "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
- "detail": "A String", # Optional details of cluster's state.
- },
- ],
- "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
- "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
- "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
- "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
- "a_key": "A String",
- },
- "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
- "yarnMetrics": { # The YARN metrics.
- "a_key": "A String",
- },
- "hdfsMetrics": { # The HDFS metrics.
- "a_key": "A String",
- },
- },
"configuration": { # The cluster configuration. # Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
"workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
@@ -778,7 +756,29 @@
"workers": [ # Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
- "numWorkers": 42, # Deprecated The number of worker nodes in the cluster.
+ "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
+ { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
+ "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
+ "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
+ },
+ ],
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
+ },
+ },
"gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Optional The shared Google Compute Engine configuration settings for all instances in a cluster.
"internalIpOnly": True or False, # If true, all instances in the cluser will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
"networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: compute.googleapis.com/projects/[project_id]/regions/global/default.
@@ -812,29 +812,7 @@
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
},
- "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
- "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
- "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
- "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
- "A String",
- ],
- "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
- "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
- { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
- "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
- "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
- },
- ],
- "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
- "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
- "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
- "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
- },
- "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
- "instanceTemplateName": "A String", # Output-only The name of Instance Template used for Managed Instance Group.
- "instanceGroupManagerName": "A String", # Output-only The name of Instance Group Manager managing this group.
- },
- },
+ "numWorkers": 42, # Deprecated The number of worker nodes in the cluster.
"initializationActions": [ # Optional Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below:
# ROLE=$(/usr/share/google/get_metadata_value attributes/role)
# if [[ "${ROLE}" == 'Master' ]]; then
@@ -894,6 +872,28 @@
},
},
},
+ "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
+ "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
+ "a_key": "A String",
+ },
+ "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
+ "yarnMetrics": { # The YARN metrics.
+ "a_key": "A String",
+ },
+ "hdfsMetrics": { # The HDFS metrics.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # Output-only Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
"createTime": "A String", # Output-only The timestamp of cluster creation.
}
@@ -920,9 +920,9 @@
},
"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). The error model is designed to be: # The error result of the operation in case of failure.
# Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
+ # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
# Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
- # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
+ # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
# Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
# Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
# Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.