Updates the settings of a specific cluster.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: container1 --scope <scope> projects zones-clusters-update ...

Required Scalar Arguments

• <project-id> (string)
  • Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
• <zone> (string)
  • Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
• <cluster-id> (string)
  • Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

UpdateClusterRequest:
  cluster-id: string
  name: string
  project-id: string
  update:
    additional-pod-ranges-config:
      pod-range-names: [string]
    desired-addons-config:
      cloud-run-config:
        disabled: boolean
        load-balancer-type: string
      config-connector-config:
        enabled: boolean
      dns-cache-config:
        enabled: boolean
      gce-persistent-disk-csi-driver-config:
        enabled: boolean
      gcp-filestore-csi-driver-config:
        enabled: boolean
      gcs-fuse-csi-driver-config:
        enabled: boolean
      gke-backup-agent-config:
        enabled: boolean
      horizontal-pod-autoscaling:
        disabled: boolean
      http-load-balancing:
        disabled: boolean
      kubernetes-dashboard:
        disabled: boolean
      network-policy-config:
        disabled: boolean
      stateful-ha-config:
        enabled: boolean
    desired-authenticator-groups-config:
      enabled: boolean
      security-group: string
    desired-autopilot-workload-policy-config:
      allow-net-admin: boolean
    desired-binary-authorization:
      enabled: boolean
      evaluation-mode: string
    desired-cluster-autoscaling:
      autoprovisioning-locations: [string]
      autoprovisioning-node-pool-defaults:
        boot-disk-kms-key: string
        disk-size-gb: integer
        disk-type: string
        image-type: string
        insecure-kubelet-readonly-port-enabled: boolean
        management:
          auto-repair: boolean
          auto-upgrade: boolean
          upgrade-options:
            auto-upgrade-start-time: string
            description: string
        min-cpu-platform: string
        oauth-scopes: [string]
        service-account: string
        shielded-instance-config:
          enable-integrity-monitoring: boolean
          enable-secure-boot: boolean
        upgrade-settings:
          blue-green-settings:
            node-pool-soak-duration: string
            standard-rollout-policy:
              batch-node-count: integer
              batch-percentage: number
              batch-soak-duration: string
          max-surge: integer
          max-unavailable: integer
          strategy: string
      autoscaling-profile: string
      enable-node-autoprovisioning: boolean
    desired-cost-management-config:
      enabled: boolean
    desired-database-encryption:
      key-name: string
      state: string
    desired-datapath-provider: string
    desired-default-snat-status:
      disabled: boolean
    desired-dns-config:
      cluster-dns: string
      cluster-dns-domain: string
      cluster-dns-scope: string
    desired-enable-fqdn-network-policy: boolean
    desired-enable-private-endpoint: boolean
    desired-fleet:
      membership: string
      pre-registered: boolean
      project: string
    desired-gateway-api-config:
      channel: string
    desired-gcfs-config:
      enabled: boolean
    desired-identity-service-config:
      enabled: boolean
    desired-image-type: string
    desired-in-transit-encryption-config: string
    desired-intra-node-visibility-config:
      enabled: boolean
    desired-k8s-beta-apis:
      enabled-apis: [string]
    desired-l4ilb-subsetting-config:
      enabled: boolean
    desired-locations: [string]
    desired-logging-config:
      component-config:
        enable-components: [string]
    desired-logging-service: string
    desired-master-authorized-networks-config:
      enabled: boolean
      gcp-public-cidrs-access-enabled: boolean
    desired-master-version: string
    desired-mesh-certificates:
      enable-certificates: boolean
    desired-monitoring-config:
      advanced-datapath-observability-config:
        enable-metrics: boolean
        enable-relay: boolean
        relay-mode: string
      component-config:
        enable-components: [string]
      managed-prometheus-config:
        enabled: boolean
    desired-monitoring-service: string
    desired-network-performance-config:
      total-egress-bandwidth-tier: string
    desired-node-pool-auto-config-network-tags:
      tags: [string]
    desired-node-pool-auto-config-resource-manager-tags:
      tags: { string: string }
    desired-node-pool-autoscaling:
      autoprovisioned: boolean
      enabled: boolean
      location-policy: string
      max-node-count: integer
      min-node-count: integer
      total-max-node-count: integer
      total-min-node-count: integer
    desired-node-pool-id: string
    desired-node-pool-logging-config:
      variant-config:
        variant: string
    desired-node-version: string
    desired-notification-config:
      pubsub:
        enabled: boolean
        filter:
          event-type: [string]
        topic: string
    desired-parent-product-config:
      labels: { string: string }
      product-name: string
    desired-private-cluster-config:
      enable-private-endpoint: boolean
      enable-private-nodes: boolean
      master-global-access-config:
        enabled: boolean
      master-ipv4-cidr-block: string
      peering-name: string
      private-endpoint: string
      private-endpoint-subnetwork: string
      public-endpoint: string
    desired-private-ipv6-google-access: string
    desired-release-channel:
      channel: string
    desired-resource-usage-export-config:
      bigquery-destination:
        dataset-id: string
      consumption-metering-config:
        enabled: boolean
      enable-network-egress-metering: boolean
    desired-security-posture-config:
      mode: string
      vulnerability-mode: string
    desired-service-external-ips-config:
      enabled: boolean
    desired-shielded-nodes:
      enabled: boolean
    desired-stack-type: string
    desired-vertical-pod-autoscaling:
      enabled: boolean
    desired-workload-identity-config:
      workload-pool: string
    enable-k8s-beta-apis:
      enabled-apis: [string]
    etag: string
    removed-additional-pod-ranges-config:
      pod-range-names: [string]
  zone: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . cluster-id=justo
  • Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
• name=rebum.
  • The name (project, location, cluster) of the cluster to update. Specified in the format projects/*/locations/*/clusters/*.
• project-id=justo
  • Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

• update.additional-pod-ranges-config pod-range-names=consetetur

  • Name for pod secondary ipv4 range which has the actual range defined ahead.
  • Each invocation of this argument appends the given value to the array.

• ..desired-addons-config.cloud-run-config disabled=true

  • Whether Cloud Run addon is enabled for this cluster.

• load-balancer-type=eos

  • Which load balancer type is installed for Cloud Run.

• ..config-connector-config enabled=false

  • Whether Cloud Connector is enabled for this cluster.

• ..dns-cache-config enabled=false

  • Whether NodeLocal DNSCache is enabled for this cluster.

• ..gce-persistent-disk-csi-driver-config enabled=false

  • Whether the Compute Engine PD CSI driver is enabled for this cluster.

• ..gcp-filestore-csi-driver-config enabled=false

  • Whether the GCP Filestore CSI driver is enabled for this cluster.

• ..gcs-fuse-csi-driver-config enabled=false

  • Whether the Cloud Storage Fuse CSI driver is enabled for this cluster.

• ..gke-backup-agent-config enabled=true

  • Whether the Backup for GKE agent is enabled for this cluster.

• ..horizontal-pod-autoscaling disabled=true

  • Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.

• ..http-load-balancing disabled=true

  • Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.

• ..kubernetes-dashboard disabled=true

  • Whether the Kubernetes Dashboard is enabled for this cluster.

• ..network-policy-config disabled=false

  • Whether NetworkPolicy is enabled for this cluster.

• ..stateful-ha-config enabled=false

  • Whether the Stateful HA add-on is enabled for this cluster.

• ...desired-authenticator-groups-config enabled=true

  • Whether this cluster should return group membership lookups during authentication using a group of security groups.

• security-group=erat

  • The name of the security group-of-groups to be used. Only relevant if enabled = true.

• ..desired-autopilot-workload-policy-config allow-net-admin=true

  • If true, workloads can use NET_ADMIN capability.

• ..desired-binary-authorization enabled=false

  • This field is deprecated. Leave this unset and instead configure BinaryAuthorization using evaluation_mode. If evaluation_mode is set to anything other than EVALUATION_MODE_UNSPECIFIED, this field is ignored.

• evaluation-mode=nonumy

  • Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.

• ..desired-cluster-autoscaling autoprovisioning-locations=magna

  • The list of Google Compute Engine zones in which the NodePool's nodes can be created by NAP.
  • Each invocation of this argument appends the given value to the array.
• autoprovisioning-node-pool-defaults boot-disk-kms-key=invidunt
  • The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
• disk-size-gb=12
  • Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
• disk-type=consetetur
  • Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
• image-type=diam
  • The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
• insecure-kubelet-readonly-port-enabled=false
  • Enable or disable Kubelet read only port.
• management auto-repair=true
  • A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
• auto-upgrade=false
  • A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
• upgrade-options auto-upgrade-start-time=dolor
  • [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in RFC3339 text format.

• description=ut

  • [Output only] This field is set when upgrades are about to commence with the description of the upgrade.

• ... min-cpu-platform=lorem

  • Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read how to specify min CPU platform. This field is deprecated, min_cpu_platform should be specified using cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
• oauth-scopes=amet
  • Scopes that are used by NAP when creating node pools.
  • Each invocation of this argument appends the given value to the array.
• service-account=elitr
  • The Google Cloud Platform Service Account to be used by the node VMs.
• shielded-instance-config enable-integrity-monitoring=true
  • Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.

• enable-secure-boot=false

  • Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

• ..upgrade-settings.blue-green-settings node-pool-soak-duration=amet.

  • Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
• standard-rollout-policy batch-node-count=28
  • Number of blue nodes to drain in a batch.
• batch-percentage=0.6546560632302685
  • Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].

• batch-soak-duration=sea

  • Soak time after each batch gets drained. Default to zero.

• ... max-surge=83

  • The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
• max-unavailable=66
  • The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.

• strategy=et

  • Update strategy of the node pool.

• ... autoscaling-profile=magna

  • Defines autoscaling behaviour.

• enable-node-autoprovisioning=true

  • Enables automatic node pool creation and deletion.

• ..desired-cost-management-config enabled=true

  • Whether the feature is enabled or not.

• ..desired-database-encryption key-name=at

  • Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

• state=diam

  • The desired state of etcd encryption.

• .. desired-datapath-provider=consetetur

  • The desired datapath provider for the cluster.

• desired-default-snat-status disabled=false

  • Disables cluster default sNAT rules.

• ..desired-dns-config cluster-dns=takimata

  • cluster_dns indicates which in-cluster DNS provider should be used.
• cluster-dns-domain=labore
  • cluster_dns_domain is the suffix used for all cluster service records.

• cluster-dns-scope=ipsum

  • cluster_dns_scope indicates the scope of access to cluster DNS records.

• .. desired-enable-fqdn-network-policy=false

  • Enable/Disable FQDN Network Policy for the cluster.
• desired-enable-private-endpoint=true
  • Enable/Disable private endpoint for the cluster's master.
• desired-fleet membership=sadipscing
  • [Output only] The full resource name of the registered fleet membership of the cluster, in the format //gkehub.googleapis.com/projects/*/locations/*/memberships/*.
• pre-registered=false
  • [Output only] Whether the cluster has been registered through the fleet API.

• project=amet

  • The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered.

• ..desired-gateway-api-config channel=diam

  • The Gateway API release channel to use for Gateway API.

• ..desired-gcfs-config enabled=false

  • Whether to use GCFS.

• ..desired-identity-service-config enabled=false

  • Whether to enable the Identity Service component

• .. desired-image-type=diam

  • The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.
• desired-in-transit-encryption-config=est
  • Specify the details of in-transit encryption.

• desired-intra-node-visibility-config enabled=false

  • Enables intra node visibility for this cluster.

• ..desired-k8s-beta-apis enabled-apis=sit

  • Enabled k8s beta APIs.
  • Each invocation of this argument appends the given value to the array.

• ..desired-l4ilb-subsetting-config enabled=true

  • Enables l4 ILB subsetting for this cluster.

• .. desired-locations=sed

  • The desired list of Google Compute Engine zones in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.
  • Each invocation of this argument appends the given value to the array.

• desired-logging-config.component-config enable-components=est

  • Select components to collect logs. An empty set would disable all logging.
  • Each invocation of this argument appends the given value to the array.

• ... desired-logging-service=labore

  • The logging service the cluster should use to write logs. Currently available options: * logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model * logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15). * none - no logs will be exported from the cluster. If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.
• desired-master-authorized-networks-config enabled=false
  • Whether or not master authorized networks is enabled.

• gcp-public-cidrs-access-enabled=false

  • Whether master is accessbile via Google Compute Engine Public IP addresses.

• .. desired-master-version=stet

  • The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version

• desired-mesh-certificates enable-certificates=true

  • enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty).

• ..desired-monitoring-config.advanced-datapath-observability-config enable-metrics=true

  • Expose flow metrics on nodes
• enable-relay=true
  • Enable Relay component

• relay-mode=est

  • Method used to make Relay available

• ..component-config enable-components=et

  • Select components to collect metrics. An empty set would disable all monitoring.
  • Each invocation of this argument appends the given value to the array.

• ..managed-prometheus-config enabled=true

  • Enable Managed Collection.

• ... desired-monitoring-service=sit

  • The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * none - No metrics will be exported from the cluster. If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

• desired-network-performance-config total-egress-bandwidth-tier=voluptua.

  • Specifies the total network bandwidth tier for NodePools in the cluster.

• ..desired-node-pool-auto-config-network-tags tags=justo

  • List of network tags.
  • Each invocation of this argument appends the given value to the array.

• ..desired-node-pool-auto-config-resource-manager-tags tags=key=stet

  • TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. tagKeys/{tag_key_id}=tagValues/{tag_value_id} 2. {org_id}/{tag_key_name}={tag_value_name} 3. {project_id}/{tag_key_name}={tag_value_name}
  • the value will be associated with the given key

• ..desired-node-pool-autoscaling autoprovisioned=true

  • Can this node pool be deleted automatically.
• enabled=false
  • Is autoscaling enabled for this node pool.
• location-policy=dolor
  • Location policy used when scaling up a nodepool.
• max-node-count=34
  • Maximum number of nodes for one location in the NodePool. Must be >= min_node_count. There has to be enough quota to scale up the cluster.
• min-node-count=27
  • Minimum number of nodes for one location in the NodePool. Must be >= 1 and <= max_node_count.
• total-max-node-count=38
  • Maximum number of nodes in the node pool. Must be greater than total_min_node_count. There has to be enough quota to scale up the cluster. The total__node_count fields are mutually exclusive with the _node_count fields.

• total-min-node-count=25

  • Minimum number of nodes in the node pool. Must be greater than 1 less than total_max_node_count. The total__node_count fields are mutually exclusive with the _node_count fields.

• .. desired-node-pool-id=sanctus

  • The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.

• desired-node-pool-logging-config.variant-config variant=dolore

  • Logging variant deployed on nodes.

• ... desired-node-version=dolores

  • The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version
• desired-notification-config.pubsub enabled=true
  • Enable notifications for Pub/Sub.

• filter event-type=et

  • Event types to allowlist.
  • Each invocation of this argument appends the given value to the array.

• .. topic=aliquyam

  • The desired Pub/Sub topic to which notifications will be sent by GKE. Format is projects/{project}/topics/{topic}.

• ...desired-parent-product-config labels=key=sed

  • Labels contain the configuration of the parent product.
  • the value will be associated with the given key

• product-name=consetetur

  • Name of the parent product associated with the cluster.

• ..desired-private-cluster-config enable-private-endpoint=false

  • Whether the master's internal IP address is used as the cluster endpoint.
• enable-private-nodes=false
  • Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.

• master-global-access-config enabled=false

  • Whenever master is accessible globally or not.

• .. master-ipv4-cidr-block=et

  • The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network.
• peering-name=sed
  • Output only. The peering name in the customer VPC used by this cluster.
• private-endpoint=rebum.
  • Output only. The internal IP address of this cluster's master endpoint.
• private-endpoint-subnetwork=voluptua.
  • Subnet to provision the master's private endpoint during cluster creation. Specified in projects//regions//subnetworks/* format.

• public-endpoint=ipsum

  • Output only. The external IP address of this cluster's master endpoint.

• .. desired-private-ipv6-google-access=rebum.

  • The desired state of IPv6 connectivity to Google Services.

• desired-release-channel channel=et

  • channel specifies which release channel the cluster is subscribed to.

• ..desired-resource-usage-export-config.bigquery-destination dataset-id=ipsum

  • The ID of a BigQuery Dataset.

• ..consumption-metering-config enabled=false

  • Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.

• .. enable-network-egress-metering=false

  • Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.

• ..desired-security-posture-config mode=dolor

  • Sets which mode to use for Security Posture features.

• vulnerability-mode=et

  • Sets which mode to use for vulnerability scanning.

• ..desired-service-external-ips-config enabled=true

  • Whether Services with ExternalIPs field are allowed or not.

• ..desired-shielded-nodes enabled=false

  • Whether Shielded Nodes features are enabled on all nodes in this cluster.

• .. desired-stack-type=consetetur

  • The desired stack type of the cluster. If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type.

• desired-vertical-pod-autoscaling enabled=false

  • Enables vertical pod autoscaling.

• ..desired-workload-identity-config workload-pool=no

  • The workload pool to attach all Kubernetes service accounts to.

• ..enable-k8s-beta-apis enabled-apis=sadipscing

  • Enabled k8s beta APIs.
  • Each invocation of this argument appends the given value to the array.

• .. etag=duo

  • The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned.

• removed-additional-pod-ranges-config pod-range-names=erat

  • Name for pod secondary ipv4 range which has the actual range defined ahead.
  • Each invocation of this argument appends the given value to the array.

• ... zone=sed

  • Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").