GDC Virtual API (gkeonprem:v1)

▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.patch

Parameters :

allowMissing

Type : boolean

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.

Location : query

▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.get

Parameters :

view

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.

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.

Type : string

Enum :

• NODE_POOL_VIEW_UNSPECIFIED
• BASIC
• FULL

Location : query

▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.list

Parameters :

view

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

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 bare metal node pool resource. This is the default value for ListBareMetalNodePoolsRequest method.

Location : query

▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.unenroll

Parameters :

allowMissing

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.

Location : query

Type : boolean

▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.list

Parameters :

view

Enum :

• NODE_POOL_VIEW_UNSPECIFIED
• BASIC
• FULL

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.

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.

Type : string

▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.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 VMware node pool resource. This is the default value for GetVmwareNodePoolRequest method.

Location : query

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.

Enum :

• NODE_POOL_VIEW_UNSPECIFIED
• BASIC
• FULL

Type : string

▼ ▲ gkeonprem.projects.locations.vmwareAdminClusters.get

Parameters :

view

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.

Location : query

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.

Enum :

• CLUSTER_VIEW_UNSPECIFIED
• BASIC
• FULL

Type : string

▼ ▲ 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

HTTP Method : POST

Parameter Order : parent

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

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

Parameters :

parent

Type : string

Location : path

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

Required : Yes

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

▼ ▲ 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

HTTP Method : POST

Parameter Order : parent

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

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

Parameters :

parent

Type : string

Location : path

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

Required : Yes

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

▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.list

Parameters :

view

Enum :

• NODE_POOL_VIEW_UNSPECIFIED
• BASIC
• FULL

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.

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.

Type : string

▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.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 VMware node pool resource. This is the default value for GetVmwareNodePoolRequest method.

Location : query

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.

Enum :

• NODE_POOL_VIEW_UNSPECIFIED
• BASIC
• FULL

Type : string

▼ ▲ gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.unenroll

Parameters :

allowMissing

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.

Location : query

Type : boolean

▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.patch

Parameters :

allowMissing

Type : boolean

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.

Location : query

▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.get

Parameters :

view

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.

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.

Type : string

Enum :

• NODE_POOL_VIEW_UNSPECIFIED
• BASIC
• FULL

Location : query

▼ ▲ gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.list

Parameters :

view

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

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 bare metal node pool resource. This is the default value for ListBareMetalNodePoolsRequest method.

Location : query

▼ ▲ gkeonprem.projects.locations.vmwareAdminClusters.get

Parameters :

view

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.

Location : query

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.

Enum :

• CLUSTER_VIEW_UNSPECIFIED
• BASIC
• FULL

Type : string