Anthos On-Prem API (gkeonprem:v1)

2023-05-31

1 new method | 7 updated methods

Additions

    Methods
  • gkeonprem.projects.locations.bareMetalStandaloneClusters.bareMetalStandaloneNodePools.enroll

      Description: Enrolls an existing bare metal standalone node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing standalone node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/bareMetalStandaloneClusters/{bareMetalStandaloneClustersId}/bareMetalStandaloneNodePools:enroll

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: parent

      HTTP Method: POST

      Path: v1/{+parent}/bareMetalStandaloneNodePools:enroll

      Parameters:

        parent

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/bareMetalStandaloneClusters/[^/]+$

          Location: path

          Description: Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/bareMetalStandaloneClusters/{cluster}

Updates

    Methods
  • gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.list

      Parameters:

        view

          Enum Descriptions:

        • If the value is not set, the default `FULL` view is used.
        • Includes basic information of a node pool resource including node pool resource name.
        • Includes the complete configuration for bare metal node pool resource. This is the default value for ListBareMetalNodePoolsRequest method.
        • Description: View for bare metal node pools. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.

          Type: string

          Location: query

          Enum:

        • NODE_POOL_VIEW_UNSPECIFIED
        • BASIC
        • FULL

  • gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.get

      Parameters:

        view

          Enum Descriptions:

        • If the value is not set, the default `FULL` view is used.
        • Includes basic information of a node pool resource including node pool resource name.
        • Includes the complete configuration for bare metal node pool resource. This is the default value for GetBareMetalNodePoolRequest method.
        • Enum:

        • NODE_POOL_VIEW_UNSPECIFIED
        • BASIC
        • FULL
        • Type: string

          Description: View for bare metal node pool. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.

          Location: query

  • gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.patch

      Parameters:

        allowMissing

          Location: query

          Description: If set to true, and the bare metal node pool is not found, the request will create a new bare metal node pool with the provided configuration. The user must have both create and update permission to call Update with allow_missing set to true.

          Type: boolean

  • gkeonprem.projects.locations.vmwareAdminClusters.get

      Parameters:

        view

          Enum Descriptions:

        • If the value is not set, the default `FULL` view is used.
        • Includes basic information of a cluster resource including cluster resource name and membership.
        • Includes the complete configuration for VMware admin cluster resource. This is the default value for GetVmwareAdminClusterRequest method.
        • Location: query

          Enum:

        • CLUSTER_VIEW_UNSPECIFIED
        • BASIC
        • FULL
        • Description: View for VMware admin cluster. When `BASIC` is specified, only the cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.

          Type: string

  • gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.get

      Parameters:

        view

          Description: View for VMware node pool. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.

          Location: query

          Type: string

          Enum:

        • NODE_POOL_VIEW_UNSPECIFIED
        • BASIC
        • FULL
        • Enum Descriptions:

        • If the value is not set, the default `FULL` view is used.
        • Includes basic information of a node pool resource including node pool resource name.
        • Includes the complete configuration for VMware node pool resource. This is the default value for GetVmwareNodePoolRequest method.

  • gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.unenroll

      Parameters:

        allowMissing

          Type: boolean

          Location: query

          Description: If set to true, and the VMware node pool is not found, the request will succeed but no action will be taken on the server and return a completed LRO.

  • gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.list

      Parameters:

        view

          Location: query

          Enum Descriptions:

        • If the value is not set, the default `FULL` view is used.
        • Includes basic information of a node pool resource including node pool resource name.
        • Includes the complete configuration for VMware node pool resource. This is the default value for ListVmwareNodePoolsRequest method.
        • Type: string

          Description: View for VMware node pools. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.

          Enum:

        • NODE_POOL_VIEW_UNSPECIFIED
        • BASIC
        • FULL