Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's default network. One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

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 locations-clusters-create ...

Required Scalar Argument

  • <parent> (string)
    • The parent (project and location) where the cluster will be created. Specified in the format projects/*/locations/*.

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:

CreateClusterRequest:
  cluster:
    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
    authenticator-groups-config:
      enabled: boolean
      security-group: string
    autopilot:
      enabled: boolean
      workload-policy-config:
        allow-net-admin: boolean
    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
    binary-authorization:
      enabled: boolean
      evaluation-mode: string
    cluster-ipv4-cidr: string
    confidential-nodes:
      enabled: boolean
    cost-management-config:
      enabled: boolean
    create-time: string
    current-master-version: string
    current-node-count: integer
    current-node-version: string
    database-encryption:
      key-name: string
      state: string
    default-max-pods-constraint:
      max-pods-per-node: string
    description: string
    enable-k8s-beta-apis:
      enabled-apis: [string]
    enable-kubernetes-alpha: boolean
    enable-tpu: boolean
    endpoint: string
    enterprise-config:
      cluster-tier: string
    etag: string
    expire-time: string
    fleet:
      membership: string
      pre-registered: boolean
      project: string
    id: string
    identity-service-config:
      enabled: boolean
    initial-cluster-version: string
    initial-node-count: integer
    instance-group-urls: [string]
    ip-allocation-policy:
      additional-pod-ranges-config:
        pod-range-names: [string]
      cluster-ipv4-cidr: string
      cluster-ipv4-cidr-block: string
      cluster-secondary-range-name: string
      create-subnetwork: boolean
      default-pod-ipv4-range-utilization: number
      ipv6-access-type: string
      node-ipv4-cidr: string
      node-ipv4-cidr-block: string
      pod-cidr-overprovision-config:
        disable: boolean
      services-ipv4-cidr: string
      services-ipv4-cidr-block: string
      services-ipv6-cidr-block: string
      services-secondary-range-name: string
      stack-type: string
      subnet-ipv6-cidr-block: string
      subnetwork-name: string
      tpu-ipv4-cidr-block: string
      use-ip-aliases: boolean
      use-routes: boolean
    label-fingerprint: string
    legacy-abac:
      enabled: boolean
    location: string
    locations: [string]
    logging-config:
      component-config:
        enable-components: [string]
    logging-service: string
    maintenance-policy:
      resource-version: string
      window:
        daily-maintenance-window:
          duration: string
          start-time: string
        recurring-window:
          recurrence: string
          window:
            end-time: string
            maintenance-exclusion-options:
              scope: string
            start-time: string
    master-auth:
      client-certificate: string
      client-certificate-config:
        issue-client-certificate: boolean
      client-key: string
      cluster-ca-certificate: string
      password: string
      username: string
    master-authorized-networks-config:
      enabled: boolean
      gcp-public-cidrs-access-enabled: boolean
    mesh-certificates:
      enable-certificates: boolean
    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
    monitoring-service: string
    name: string
    network: string
    network-config:
      datapath-provider: string
      default-snat-status:
        disabled: boolean
      dns-config:
        cluster-dns: string
        cluster-dns-domain: string
        cluster-dns-scope: string
      enable-fqdn-network-policy: boolean
      enable-intra-node-visibility: boolean
      enable-l4ilb-subsetting: boolean
      enable-multi-networking: boolean
      gateway-api-config:
        channel: string
      in-transit-encryption-config: string
      network: string
      network-performance-config:
        total-egress-bandwidth-tier: string
      private-ipv6-google-access: string
      service-external-ips-config:
        enabled: boolean
      subnetwork: string
    network-policy:
      enabled: boolean
      provider: string
    node-config:
      advanced-machine-features:
        threads-per-core: string
      boot-disk-kms-key: string
      confidential-nodes:
        enabled: boolean
      disk-size-gb: integer
      disk-type: string
      enable-confidential-storage: boolean
      ephemeral-storage-local-ssd-config:
        local-ssd-count: integer
      fast-socket:
        enabled: boolean
      gcfs-config:
        enabled: boolean
      gvnic:
        enabled: boolean
      image-type: string
      kubelet-config:
        cpu-cfs-quota: boolean
        cpu-cfs-quota-period: string
        cpu-manager-policy: string
        insecure-kubelet-readonly-port-enabled: boolean
        pod-pids-limit: string
      labels: { string: string }
      linux-node-config:
        cgroup-mode: string
        sysctls: { string: string }
      local-nvme-ssd-block-config:
        local-ssd-count: integer
      local-ssd-count: integer
      logging-config:
        variant-config:
          variant: string
      machine-type: string
      metadata: { string: string }
      min-cpu-platform: string
      node-group: string
      oauth-scopes: [string]
      preemptible: boolean
      reservation-affinity:
        consume-reservation-type: string
        key: string
        values: [string]
      resource-labels: { string: string }
      resource-manager-tags:
        tags: { string: string }
      sandbox-config:
        type: string
      service-account: string
      shielded-instance-config:
        enable-integrity-monitoring: boolean
        enable-secure-boot: boolean
      spot: boolean
      tags: [string]
      windows-node-config:
        os-version: string
      workload-metadata-config:
        mode: string
    node-ipv4-cidr-size: integer
    node-pool-auto-config:
      network-tags:
        tags: [string]
      resource-manager-tags:
        tags: { string: string }
    node-pool-defaults:
      node-config-defaults:
        gcfs-config:
          enabled: boolean
        logging-config:
          variant-config:
            variant: string
    notification-config:
      pubsub:
        enabled: boolean
        filter:
          event-type: [string]
        topic: string
    parent-product-config:
      labels: { string: string }
      product-name: string
    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
    release-channel:
      channel: string
    resource-labels: { string: string }
    resource-usage-export-config:
      bigquery-destination:
        dataset-id: string
      consumption-metering-config:
        enabled: boolean
      enable-network-egress-metering: boolean
    security-posture-config:
      mode: string
      vulnerability-mode: string
    self-link: string
    services-ipv4-cidr: string
    shielded-nodes:
      enabled: boolean
    status: string
    status-message: string
    subnetwork: string
    tpu-ipv4-cidr-block: string
    vertical-pod-autoscaling:
      enabled: boolean
    workload-identity-config:
      workload-pool: string
    zone: string
  parent: string
  project-id: 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.addons-config.cloud-run-config disabled=false
    • Whether Cloud Run addon is enabled for this cluster.

  • load-balancer-type=amet.

    • Which load balancer type is installed for Cloud Run.

  • ..config-connector-config enabled=true

    • Whether Cloud Connector is enabled for this cluster.

  • ..dns-cache-config enabled=true

    • Whether NodeLocal DNSCache is enabled for this cluster.

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

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

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

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

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

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

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

    • 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=false

    • 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=true

    • Whether NetworkPolicy is enabled for this cluster.

  • ..stateful-ha-config enabled=false

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

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

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

  • security-group=ipsum

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

  • ..autopilot enabled=true

    • Enable Autopilot

  • workload-policy-config allow-net-admin=true

    • If true, workloads can use NET_ADMIN capability.

  • ...autoscaling autoprovisioning-locations=ea

    • 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=dolor
    • 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=45
    • 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=eos
    • 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=labore
    • 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=true
    • Enable or disable Kubelet read only port.
  • management auto-repair=false
    • 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=no
    • [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=stet

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

  • ... min-cpu-platform=kasd

    • 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=et
    • Scopes that are used by NAP when creating node pools.
    • Each invocation of this argument appends the given value to the array.
  • service-account=sed
    • 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=erat

    • Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
  • standard-rollout-policy batch-node-count=8
    • Number of blue nodes to drain in a batch.
  • batch-percentage=0.6383502522516505
    • 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=et

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

  • ... max-surge=73

    • The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
  • max-unavailable=99
    • 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=consetetur

    • Update strategy of the node pool.

  • ... autoscaling-profile=diam

    • Defines autoscaling behaviour.

  • enable-node-autoprovisioning=true

    • Enables automatic node pool creation and deletion.

  • ..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=stet

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

  • .. cluster-ipv4-cidr=dolor

    • The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.

  • confidential-nodes enabled=false

    • Whether Confidential Nodes feature is enabled.

  • ..cost-management-config enabled=false

    • Whether the feature is enabled or not.

  • .. create-time=invidunt

    • [Output only] The time the cluster was created, in RFC3339 text format.
  • current-master-version=stet
    • [Output only] The current software version of the master endpoint.
  • current-node-count=25
    • [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
  • current-node-version=elitr
    • [Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
  • database-encryption key-name=lorem
    • 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.

  • ..default-max-pods-constraint max-pods-per-node=no

    • Constraint enforced on the max num of pods per node.

  • .. description=ipsum

    • An optional description of this cluster.

  • enable-k8s-beta-apis enabled-apis=accusam

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

  • .. enable-kubernetes-alpha=true

    • Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.
  • enable-tpu=true
    • Enable the ability to use Cloud TPUs in this cluster.
  • endpoint=voluptua.
    • [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/. See the masterAuth property of this resource for username and password information.

  • enterprise-config cluster-tier=et

    • Output only. [Output only] cluster_tier specifies the premium tier of the cluster.

  • .. etag=erat

    • This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
  • expire-time=consetetur
    • [Output only] The time the cluster will be automatically deleted in RFC3339 text format.
  • fleet membership=amet.
    • [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=true
    • [Output only] Whether the cluster has been registered through the fleet API.

  • project=et

    • 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.

  • .. id=accusam

    • Output only. Unique id for the cluster.

  • identity-service-config enabled=false

    • Whether to enable the Identity Service component

  • .. initial-cluster-version=dolore

    • The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. 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
  • initial-node-count=67
    • The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
  • instance-group-urls=dolore
    • Deprecated. Use node_pools.instance_group_urls.
    • Each invocation of this argument appends the given value to the array.

  • ip-allocation-policy.additional-pod-ranges-config pod-range-names=voluptua.

    • 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.

  • .. cluster-ipv4-cidr=amet.

    • This field is deprecated, use cluster_ipv4_cidr_block.
  • cluster-ipv4-cidr-block=ea
    • The IP address range for the cluster pod IPs. If this field is set, then cluster.cluster_ipv4_cidr must be left blank. This field is only applicable when use_ip_aliases is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.
  • cluster-secondary-range-name=sadipscing
    • The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
  • create-subnetwork=true
    • Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when use_ip_aliases is true.
  • default-pod-ipv4-range-utilization=0.7036393712200139
    • Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodesnumZonespodIPsPerNode.
  • ipv6-access-type=at
    • The ipv6 access type (internal or external) when create_subnetwork is true
  • node-ipv4-cidr=sed
    • This field is deprecated, use node_ipv4_cidr_block.
  • node-ipv4-cidr-block=sit
    • The IP address range of the instance IPs in this cluster. This is applicable only if create_subnetwork is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

  • pod-cidr-overprovision-config disable=true

    • Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.

  • .. services-ipv4-cidr=aliquyam

    • This field is deprecated, use services_ipv4_cidr_block.
  • services-ipv4-cidr-block=ipsum
    • The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when use_ip_aliases is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.
  • services-ipv6-cidr-block=et
    • Output only. [Output only] The services IPv6 CIDR block for the cluster.
  • services-secondary-range-name=sanctus
    • The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
  • stack-type=lorem
    • The IP stack type of the cluster
  • subnet-ipv6-cidr-block=est
    • Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.
  • subnetwork-name=sed
    • A custom subnetwork name to be used if create_subnetwork is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.
  • tpu-ipv4-cidr-block=diam
    • The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when use_ip_aliases is true. If unspecified, the range will use the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.
  • use-ip-aliases=true
    • Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode

  • use-routes=true

    • Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode

  • .. label-fingerprint=sed

    • The fingerprint of the set of labels for this cluster.

  • legacy-abac enabled=false

    • Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.

  • .. location=elitr

    • [Output only] The name of the Google Compute Engine zone or region in which the cluster resides.
  • locations=sed
    • The list of Google Compute Engine zones in which the cluster's nodes should be located. This field provides a default value if NodePool.Locations are not specified during node pool creation. Warning: changing cluster locations will update the NodePool.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.

  • logging-config.component-config enable-components=no

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

  • ... logging-service=nonumy

    • 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.
  • maintenance-policy resource-version=at
    • A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a get() request to the cluster to get the current resource version and include it with requests to set the policy.
  • window.daily-maintenance-window duration=sadipscing
    • [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in RFC3339 format "PTnHnMnS".

  • start-time=aliquyam

    • Time within the maintenance window to start the maintenance operations. Time format should be in RFC3339 format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

  • ..recurring-window recurrence=dolores

    • An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR To repeat some window daily (equivalent to the DailyMaintenanceWindow): FREQ=DAILY For the first weekend of every month: FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.
  • window end-time=sadipscing
    • The time that the window ends. The end time should take place after the start time.

  • maintenance-exclusion-options scope=erat

    • Scope specifies the upgrade scope which upgrades are blocked by the exclusion.

  • .. start-time=aliquyam

    • The time that the window first starts.

  • .....master-auth client-certificate=amet

    • [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.

  • client-certificate-config issue-client-certificate=true

    • Issue a client certificate.

  • .. client-key=et

    • [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
  • cluster-ca-certificate=sea
    • [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
  • password=consetetur
    • The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

  • username=consetetur

    • The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

  • ..master-authorized-networks-config enabled=true

    • 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.

  • ..mesh-certificates enable-certificates=false

    • 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).

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

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

  • relay-mode=sit

    • Method used to make Relay available

  • ..component-config enable-components=sed

    • 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=false

    • Enable Managed Collection.

  • ... monitoring-service=lorem

    • 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.
  • name=ea
    • The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
  • network=stet
    • The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.
  • network-config datapath-provider=dolores
    • The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.

  • default-snat-status disabled=true

    • Disables cluster default sNAT rules.

  • ..dns-config cluster-dns=sea

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

  • cluster-dns-scope=at

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

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

    • Whether FQDN Network Policy is enabled on this cluster.
  • enable-intra-node-visibility=true
    • Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.
  • enable-l4ilb-subsetting=true
    • Whether L4ILB Subsetting is enabled for this cluster.
  • enable-multi-networking=true
    • Whether multi-networking is enabled for this cluster.

  • gateway-api-config channel=erat

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

  • .. in-transit-encryption-config=dolores

    • Specify the details of in-transit encryption.
  • network=erat
    • Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network

  • network-performance-config total-egress-bandwidth-tier=accusam

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

  • .. private-ipv6-google-access=sea

    • The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4)

  • service-external-ips-config enabled=true

    • Whether Services with ExternalIPs field are allowed or not.

  • .. subnetwork=lorem

    • Output only. The relative name of the Google Compute Engine subnetwork to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet

  • ..network-policy enabled=false

    • Whether network policy is enabled on the cluster.

  • provider=dolor

    • The selected network policy provider.

  • ..node-config.advanced-machine-features threads-per-core=et

    • The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

  • .. boot-disk-kms-key=sit

    • 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

  • confidential-nodes enabled=false

    • Whether Confidential Nodes feature is enabled.

  • .. disk-size-gb=91

    • 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=nonumy
    • 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'
  • enable-confidential-storage=true
    • Optional. Reserved for future use.

  • ephemeral-storage-local-ssd-config local-ssd-count=5

    • Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.

  • ..fast-socket enabled=false

    • Whether Fast Socket features are enabled in the node pool.

  • ..gcfs-config enabled=false

    • Whether to use GCFS.

  • ..gvnic enabled=true

    • Whether gVNIC features are enabled in the node pool.

  • .. image-type=gubergren

    • The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
  • kubelet-config cpu-cfs-quota=true
    • Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
  • cpu-cfs-quota-period=amet.
    • Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.
  • cpu-manager-policy=ipsum
    • Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
  • insecure-kubelet-readonly-port-enabled=true
    • Enable or disable Kubelet read only port.

  • pod-pids-limit=accusam

    • Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.

  • .. labels=key=gubergren

    • The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
    • the value will be associated with the given key
  • linux-node-config cgroup-mode=sadipscing
    • cgroup_mode specifies the cgroup mode to be used on the node.

  • sysctls=key=at

    • The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse
    • the value will be associated with the given key

  • ..local-nvme-ssd-block-config local-ssd-count=48

    • Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.

  • .. local-ssd-count=81

    • The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.

  • logging-config.variant-config variant=sit

    • Logging variant deployed on nodes.

  • ... machine-type=magna

    • The name of a Google Compute Engine machine type If unspecified, the default machine type is e2-medium.
  • metadata=key=et
    • The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
    • the value will be associated with the given key
  • min-cpu-platform=rebum.
    • Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: &#34;Intel Haswell&#34; or minCpuPlatform: &#34;Intel Sandy Bridge&#34;. For more information, read how to specify min CPU platform
  • node-group=dolor
    • Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes.
  • oauth-scopes=lorem
    • The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * https://www.googleapis.com/auth/compute is required for mounting persistent storage on your nodes. * https://www.googleapis.com/auth/devstorage.read_only is required for communicating with gcr.io (the Google Container Registry). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
    • Each invocation of this argument appends the given value to the array.
  • preemptible=false
    • Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
  • reservation-affinity consume-reservation-type=amet.
    • Corresponds to the type of reservation consumption.
  • key=no
    • Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.

  • values=nonumy

    • Corresponds to the label value(s) of reservation resource(s).
    • Each invocation of this argument appends the given value to the array.

  • .. resource-labels=key=sed

    • The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
    • the value will be associated with the given key

  • resource-manager-tags tags=key=kasd

    • 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

  • ..sandbox-config type=lorem

    • Type of the sandbox to use for the node.

  • .. service-account=sanctus

    • The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
  • shielded-instance-config enable-integrity-monitoring=false
    • 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=true

    • 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.

  • .. spot=true

    • Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
  • tags=dolore
    • The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
    • Each invocation of this argument appends the given value to the array.

  • windows-node-config os-version=eos

    • OSVersion specifies the Windows node config to be used on the node

  • ..workload-metadata-config mode=amet.

    • Mode is the configuration for how to expose metadata to workloads running on the node pool.

  • ... node-ipv4-cidr-size=17

    • [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.

  • node-pool-auto-config.network-tags tags=amet

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

  • ..resource-manager-tags tags=key=ut

    • 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

  • ...node-pool-defaults.node-config-defaults.gcfs-config enabled=true

    • Whether to use GCFS.

  • ..logging-config.variant-config variant=vero

    • Logging variant deployed on nodes.

  • .....notification-config.pubsub enabled=true

    • Enable notifications for Pub/Sub.

  • filter event-type=ut

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

  • .. topic=rebum.

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

  • ...parent-product-config labels=key=duo

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

  • product-name=kasd

    • Name of the parent product associated with the cluster.

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

    • Whether the master's internal IP address is used as the cluster endpoint.
  • enable-private-nodes=true
    • 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=lorem

    • 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=magna
    • Output only. The peering name in the customer VPC used by this cluster.
  • private-endpoint=takimata
    • Output only. The internal IP address of this cluster's master endpoint.
  • private-endpoint-subnetwork=rebum.
    • Subnet to provision the master's private endpoint during cluster creation. Specified in projects//regions//subnetworks/* format.

  • public-endpoint=at

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

  • ..release-channel channel=invidunt

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

  • .. resource-labels=key=clita

    • The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
    • the value will be associated with the given key

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

    • 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.

  • ..security-posture-config mode=dolores

    • Sets which mode to use for Security Posture features.

  • vulnerability-mode=sed

    • Sets which mode to use for vulnerability scanning.

  • .. self-link=invidunt

    • [Output only] Server-defined URL for the resource.
  • services-ipv4-cidr=clita
    • [Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.

  • shielded-nodes enabled=false

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

  • .. status=aliquyam

    • [Output only] The current status of this cluster.
  • status-message=magna
    • [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
  • subnetwork=diam
    • The name of the Google Compute Engine subnetwork to which the cluster is connected.
  • tpu-ipv4-cidr-block=nonumy
    • [Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).

  • vertical-pod-autoscaling enabled=true

    • Enables vertical pod autoscaling.

  • ..workload-identity-config workload-pool=sed

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

  • .. zone=est

    • [Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

  • .. parent=takimata

    • The parent (project and location) where the cluster will be created. Specified in the format projects/*/locations/*.
  • project-id=dolor
  • zone=diam
    • Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent 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").