gkeonprem

import { gkeonprem } from "https://googleapis.deno.dev/v1/gkeonprem:v1.ts";

class gkeonprem {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsBareMetalAdminClustersCreate(

parent: string,

req: BareMetalAdminCluster,

opts?: ProjectsLocationsBareMetalAdminClustersCreateOptions,

): Promise<Operation>;

async projectsLocationsBareMetalAdminClustersEnroll(parent: string, req: EnrollBareMetalAdminClusterRequest): Promise<Operation>;

async projectsLocationsBareMetalAdminClustersGet(name: string, opts?: ProjectsLocationsBareMetalAdminClustersGetOptions): Promise<BareMetalAdminCluster>;

async projectsLocationsBareMetalAdminClustersGetIamPolicy(resource: string, opts?: ProjectsLocationsBareMetalAdminClustersGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsBareMetalAdminClustersList(parent: string, opts?: ProjectsLocationsBareMetalAdminClustersListOptions): Promise<ListBareMetalAdminClustersResponse>;

async projectsLocationsBareMetalAdminClustersOperationsGet(name: string): Promise<Operation>;

async projectsLocationsBareMetalAdminClustersOperationsList(name: string, opts?: ProjectsLocationsBareMetalAdminClustersOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsBareMetalAdminClustersPatch(

req: BareMetalAdminCluster,

opts?: ProjectsLocationsBareMetalAdminClustersPatchOptions,

): Promise<Operation>;

async projectsLocationsBareMetalAdminClustersQueryVersionConfig(parent: string, opts?: ProjectsLocationsBareMetalAdminClustersQueryVersionConfigOptions): Promise<QueryBareMetalAdminVersionConfigResponse>;

async projectsLocationsBareMetalAdminClustersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsBareMetalAdminClustersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsBareMetalAdminClustersUnenroll(name: string, opts?: ProjectsLocationsBareMetalAdminClustersUnenrollOptions): Promise<Operation>;

async projectsLocationsBareMetalClustersBareMetalNodePoolsCreate(

parent: string,

req: BareMetalNodePool,

opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsCreateOptions,

): Promise<Operation>;

async projectsLocationsBareMetalClustersBareMetalNodePoolsDelete(name: string, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsDeleteOptions): Promise<Operation>;

async projectsLocationsBareMetalClustersBareMetalNodePoolsEnroll(parent: string, req: EnrollBareMetalNodePoolRequest): Promise<Operation>;

async projectsLocationsBareMetalClustersBareMetalNodePoolsGet(name: string, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsGetOptions): Promise<BareMetalNodePool>;

async projectsLocationsBareMetalClustersBareMetalNodePoolsGetIamPolicy(resource: string, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsBareMetalClustersBareMetalNodePoolsList(parent: string, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsListOptions): Promise<ListBareMetalNodePoolsResponse>;

async projectsLocationsBareMetalClustersBareMetalNodePoolsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsBareMetalClustersBareMetalNodePoolsOperationsList(name: string, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsBareMetalClustersBareMetalNodePoolsPatch(

req: BareMetalNodePool,

opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsPatchOptions,

): Promise<Operation>;

async projectsLocationsBareMetalClustersBareMetalNodePoolsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsBareMetalClustersBareMetalNodePoolsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsBareMetalClustersBareMetalNodePoolsUnenroll(name: string, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsUnenrollOptions): Promise<Operation>;

async projectsLocationsBareMetalClustersCreate(

parent: string,

req: BareMetalCluster,

opts?: ProjectsLocationsBareMetalClustersCreateOptions,

): Promise<Operation>;

async projectsLocationsBareMetalClustersDelete(name: string, opts?: ProjectsLocationsBareMetalClustersDeleteOptions): Promise<Operation>;

async projectsLocationsBareMetalClustersEnroll(parent: string, req: EnrollBareMetalClusterRequest): Promise<Operation>;

async projectsLocationsBareMetalClustersGet(name: string, opts?: ProjectsLocationsBareMetalClustersGetOptions): Promise<BareMetalCluster>;

async projectsLocationsBareMetalClustersGetIamPolicy(resource: string, opts?: ProjectsLocationsBareMetalClustersGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsBareMetalClustersList(parent: string, opts?: ProjectsLocationsBareMetalClustersListOptions): Promise<ListBareMetalClustersResponse>;

async projectsLocationsBareMetalClustersOperationsGet(name: string): Promise<Operation>;

async projectsLocationsBareMetalClustersOperationsList(name: string, opts?: ProjectsLocationsBareMetalClustersOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsBareMetalClustersPatch(

req: BareMetalCluster,

opts?: ProjectsLocationsBareMetalClustersPatchOptions,

): Promise<Operation>;

async projectsLocationsBareMetalClustersQueryVersionConfig(parent: string, opts?: ProjectsLocationsBareMetalClustersQueryVersionConfigOptions): Promise<QueryBareMetalVersionConfigResponse>;

async projectsLocationsBareMetalClustersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsBareMetalClustersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsBareMetalClustersUnenroll(name: string, opts?: ProjectsLocationsBareMetalClustersUnenrollOptions): Promise<Operation>;

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsVmwareAdminClustersEnroll(parent: string, req: EnrollVmwareAdminClusterRequest): Promise<Operation>;

async projectsLocationsVmwareAdminClustersGet(name: string, opts?: ProjectsLocationsVmwareAdminClustersGetOptions): Promise<VmwareAdminCluster>;

async projectsLocationsVmwareAdminClustersGetIamPolicy(resource: string, opts?: ProjectsLocationsVmwareAdminClustersGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsVmwareAdminClustersList(parent: string, opts?: ProjectsLocationsVmwareAdminClustersListOptions): Promise<ListVmwareAdminClustersResponse>;

async projectsLocationsVmwareAdminClustersOperationsGet(name: string): Promise<Operation>;

async projectsLocationsVmwareAdminClustersOperationsList(name: string, opts?: ProjectsLocationsVmwareAdminClustersOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsVmwareAdminClustersPatch(

req: VmwareAdminCluster,

opts?: ProjectsLocationsVmwareAdminClustersPatchOptions,

): Promise<Operation>;

async projectsLocationsVmwareAdminClustersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsVmwareAdminClustersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsVmwareAdminClustersUnenroll(name: string, opts?: ProjectsLocationsVmwareAdminClustersUnenrollOptions): Promise<Operation>;

async projectsLocationsVmwareClustersCreate(

parent: string,

req: VmwareCluster,

opts?: ProjectsLocationsVmwareClustersCreateOptions,

): Promise<Operation>;

async projectsLocationsVmwareClustersDelete(name: string, opts?: ProjectsLocationsVmwareClustersDeleteOptions): Promise<Operation>;

async projectsLocationsVmwareClustersEnroll(parent: string, req: EnrollVmwareClusterRequest): Promise<Operation>;

async projectsLocationsVmwareClustersGet(name: string, opts?: ProjectsLocationsVmwareClustersGetOptions): Promise<VmwareCluster>;

async projectsLocationsVmwareClustersGetIamPolicy(resource: string, opts?: ProjectsLocationsVmwareClustersGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsVmwareClustersList(parent: string, opts?: ProjectsLocationsVmwareClustersListOptions): Promise<ListVmwareClustersResponse>;

async projectsLocationsVmwareClustersOperationsGet(name: string): Promise<Operation>;

async projectsLocationsVmwareClustersOperationsList(name: string, opts?: ProjectsLocationsVmwareClustersOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsVmwareClustersPatch(

req: VmwareCluster,

opts?: ProjectsLocationsVmwareClustersPatchOptions,

): Promise<Operation>;

async projectsLocationsVmwareClustersQueryVersionConfig(parent: string, opts?: ProjectsLocationsVmwareClustersQueryVersionConfigOptions): Promise<QueryVmwareVersionConfigResponse>;

async projectsLocationsVmwareClustersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsVmwareClustersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsVmwareClustersUnenroll(name: string, opts?: ProjectsLocationsVmwareClustersUnenrollOptions): Promise<Operation>;

async projectsLocationsVmwareClustersVmwareNodePoolsCreate(

parent: string,

req: VmwareNodePool,

opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsCreateOptions,

): Promise<Operation>;

async projectsLocationsVmwareClustersVmwareNodePoolsDelete(name: string, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsDeleteOptions): Promise<Operation>;

async projectsLocationsVmwareClustersVmwareNodePoolsEnroll(parent: string, req: EnrollVmwareNodePoolRequest): Promise<Operation>;

async projectsLocationsVmwareClustersVmwareNodePoolsGet(name: string, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsGetOptions): Promise<VmwareNodePool>;

async projectsLocationsVmwareClustersVmwareNodePoolsGetIamPolicy(resource: string, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsVmwareClustersVmwareNodePoolsList(parent: string, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsListOptions): Promise<ListVmwareNodePoolsResponse>;

async projectsLocationsVmwareClustersVmwareNodePoolsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsVmwareClustersVmwareNodePoolsOperationsList(name: string, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsVmwareClustersVmwareNodePoolsPatch(

req: VmwareNodePool,

opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsPatchOptions,

): Promise<Operation>;

async projectsLocationsVmwareClustersVmwareNodePoolsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsVmwareClustersVmwareNodePoolsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsVmwareClustersVmwareNodePoolsUnenroll(name: string, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsUnenrollOptions): Promise<Operation>;

}

§Constructors

new gkeonprem(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsBareMetalAdminClustersCreate(parent: string, req: BareMetalAdminCluster, opts?: ProjectsLocationsBareMetalAdminClustersCreateOptions): Promise<Operation>

[src]

Creates a new bare metal admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work. See: https://cloud.google.com/anthos/clusters/docs/bare-metal/latest/installing/creating-clusters/create-admin-cluster-api#prepare_bootstrap_environment

@param parent

Required. The parent of the project and location where the cluster is created in. Format: "projects/{project}/locations/{location}"

projectsLocationsBareMetalAdminClustersEnroll(parent: string, req: EnrollBareMetalAdminClusterRequest): Promise<Operation>

[src]

Enrolls an existing bare metal admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API.

@param parent

Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/{project}/locations/{location}"

projectsLocationsBareMetalAdminClustersGet(name: string, opts?: ProjectsLocationsBareMetalAdminClustersGetOptions): Promise<BareMetalAdminCluster>

[src]

Gets details of a single bare metal admin cluster.

@param name

Required. Name of the bare metal admin cluster to get. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{bare_metal_admin_cluster}"

projectsLocationsBareMetalAdminClustersGetIamPolicy(resource: string, opts?: ProjectsLocationsBareMetalAdminClustersGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsBareMetalAdminClustersList(parent: string, opts?: ProjectsLocationsBareMetalAdminClustersListOptions): Promise<ListBareMetalAdminClustersResponse>

[src]

Lists bare metal admin clusters in a given project and location.

@param parent

Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}"

projectsLocationsBareMetalAdminClustersOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsBareMetalAdminClustersOperationsList(name: string, opts?: ProjectsLocationsBareMetalAdminClustersOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsBareMetalAdminClustersPatch(name: string, req: BareMetalAdminCluster, opts?: ProjectsLocationsBareMetalAdminClustersPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single bare metal admin cluster.

@param name

Immutable. The bare metal admin cluster resource name.

projectsLocationsBareMetalAdminClustersQueryVersionConfig(parent: string, opts?: ProjectsLocationsBareMetalAdminClustersQueryVersionConfigOptions): Promise<QueryBareMetalAdminVersionConfigResponse>

[src]

Queries the bare metal admin cluster version config.

@param parent

Required. The parent of the project and location to query for version config. Format: "projects/{project}/locations/{location}"

projectsLocationsBareMetalAdminClustersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsBareMetalAdminClustersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsBareMetalAdminClustersUnenroll(name: string, opts?: ProjectsLocationsBareMetalAdminClustersUnenrollOptions): Promise<Operation>

[src]

Unenrolls an existing bare metal admin cluster from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.

@param name

Required. Name of the bare metal admin cluster to be unenrolled. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{cluster}"

projectsLocationsBareMetalClustersBareMetalNodePoolsCreate(parent: string, req: BareMetalNodePool, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsCreateOptions): Promise<Operation>

[src]

Creates a new bare metal node pool in a given project, location and Bare Metal cluster.

@param parent

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

projectsLocationsBareMetalClustersBareMetalNodePoolsDelete(name: string, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsDeleteOptions): Promise<Operation>

[src]

Deletes a single bare metal node pool.

@param name

Required. The name of the node pool to delete. Format: projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool}

projectsLocationsBareMetalClustersBareMetalNodePoolsEnroll(parent: string, req: EnrollBareMetalNodePoolRequest): Promise<Operation>

[src]

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

@param parent

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

projectsLocationsBareMetalClustersBareMetalNodePoolsGet(name: string, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsGetOptions): Promise<BareMetalNodePool>

[src]

Gets details of a single bare metal node pool.

@param name

Required. The name of the node pool to retrieve. projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool}

projectsLocationsBareMetalClustersBareMetalNodePoolsGetIamPolicy(resource: string, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsBareMetalClustersBareMetalNodePoolsList(parent: string, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsListOptions): Promise<ListBareMetalNodePoolsResponse>

[src]

Lists bare metal node pools in a given project, location and bare metal cluster.

@param parent

Required. The parent, which owns this collection of node pools. Format: projects/{project}/locations/{location}/bareMetalClusters/{bareMetalCluster}

projectsLocationsBareMetalClustersBareMetalNodePoolsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsBareMetalClustersBareMetalNodePoolsOperationsList(name: string, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsBareMetalClustersBareMetalNodePoolsPatch(name: string, req: BareMetalNodePool, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single bare metal node pool.

@param name

Immutable. The bare metal node pool resource name.

projectsLocationsBareMetalClustersBareMetalNodePoolsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsBareMetalClustersBareMetalNodePoolsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsBareMetalClustersBareMetalNodePoolsUnenroll(name: string, opts?: ProjectsLocationsBareMetalClustersBareMetalNodePoolsUnenrollOptions): Promise<Operation>

[src]

Unenrolls a bare metal node pool from Anthos On-Prem API.

@param name

Required. The name of the node pool to unenroll. Format: projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool}

projectsLocationsBareMetalClustersCreate(parent: string, req: BareMetalCluster, opts?: ProjectsLocationsBareMetalClustersCreateOptions): Promise<Operation>

[src]

Creates a new bare metal cluster in a given project and location.

@param parent

Required. The parent of the project and location where the cluster is created in. Format: "projects/{project}/locations/{location}"

projectsLocationsBareMetalClustersDelete(name: string, opts?: ProjectsLocationsBareMetalClustersDeleteOptions): Promise<Operation>

[src]

Deletes a single bare metal Cluster.

@param name

Required. Name of the bare metal user cluster to be deleted. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}"

projectsLocationsBareMetalClustersEnroll(parent: string, req: EnrollBareMetalClusterRequest): Promise<Operation>

[src]

Enrolls an existing bare metal user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.

@param parent

Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/{project}/locations/{location}"

projectsLocationsBareMetalClustersGet(name: string, opts?: ProjectsLocationsBareMetalClustersGetOptions): Promise<BareMetalCluster>

[src]

Gets details of a single bare metal Cluster.

@param name

Required. Name of the bare metal user cluster to get. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}"

projectsLocationsBareMetalClustersGetIamPolicy(resource: string, opts?: ProjectsLocationsBareMetalClustersGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsBareMetalClustersList(parent: string, opts?: ProjectsLocationsBareMetalClustersListOptions): Promise<ListBareMetalClustersResponse>

[src]

Lists bare metal clusters in a given project and location.

@param parent

Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}"

projectsLocationsBareMetalClustersOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsBareMetalClustersOperationsList(name: string, opts?: ProjectsLocationsBareMetalClustersOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsBareMetalClustersPatch(name: string, req: BareMetalCluster, opts?: ProjectsLocationsBareMetalClustersPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single bare metal Cluster.

@param name

Immutable. The bare metal user cluster resource name.

projectsLocationsBareMetalClustersQueryVersionConfig(parent: string, opts?: ProjectsLocationsBareMetalClustersQueryVersionConfigOptions): Promise<QueryBareMetalVersionConfigResponse>

[src]

Queries the bare metal user cluster version config.

@param parent

Required. The parent of the project and location to query for version config. Format: "projects/{project}/locations/{location}"

projectsLocationsBareMetalClustersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsBareMetalClustersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsBareMetalClustersUnenroll(name: string, opts?: ProjectsLocationsBareMetalClustersUnenrollOptions): Promise<Operation>

[src]

Unenrolls an existing bare metal user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.

@param name

Required. Name of the bare metal user cluster to be unenrolled. Format: "projects/{project}/locations/{location}/bareMetalClusters/{cluster}"

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsVmwareAdminClustersEnroll(parent: string, req: EnrollVmwareAdminClusterRequest): Promise<Operation>

[src]

Enrolls an existing VMware admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API.

@param parent

Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/{project}/locations/{location}"

projectsLocationsVmwareAdminClustersGet(name: string, opts?: ProjectsLocationsVmwareAdminClustersGetOptions): Promise<VmwareAdminCluster>

[src]

Gets details of a single VMware admin cluster.

@param name

Required. Name of the VMware admin cluster to be returned. Format: "projects/{project}/locations/{location}/vmwareAdminClusters/{vmware_admin_cluster}"

projectsLocationsVmwareAdminClustersGetIamPolicy(resource: string, opts?: ProjectsLocationsVmwareAdminClustersGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsVmwareAdminClustersList(parent: string, opts?: ProjectsLocationsVmwareAdminClustersListOptions): Promise<ListVmwareAdminClustersResponse>

[src]

Lists VMware admin clusters in a given project and location.

@param parent

Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}"

projectsLocationsVmwareAdminClustersOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsVmwareAdminClustersOperationsList(name: string, opts?: ProjectsLocationsVmwareAdminClustersOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsVmwareAdminClustersPatch(name: string, req: VmwareAdminCluster, opts?: ProjectsLocationsVmwareAdminClustersPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single VMware admin cluster.

@param name

Immutable. The VMware admin cluster resource name.

projectsLocationsVmwareAdminClustersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsVmwareAdminClustersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsVmwareAdminClustersUnenroll(name: string, opts?: ProjectsLocationsVmwareAdminClustersUnenrollOptions): Promise<Operation>

[src]

Unenrolls an existing VMware admin cluster from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.

@param name

Required. Name of the VMware admin cluster to be unenrolled. Format: "projects/{project}/locations/{location}/vmwareAdminClusters/{cluster}"

projectsLocationsVmwareClustersCreate(parent: string, req: VmwareCluster, opts?: ProjectsLocationsVmwareClustersCreateOptions): Promise<Operation>

[src]

Creates a new VMware user cluster in a given project and location.

@param parent

Required. The parent of the project and location where this cluster is created in. Format: "projects/{project}/locations/{location}"

projectsLocationsVmwareClustersDelete(name: string, opts?: ProjectsLocationsVmwareClustersDeleteOptions): Promise<Operation>

[src]

Deletes a single VMware Cluster.

@param name

Required. Name of the VMware user cluster to be deleted. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}"

projectsLocationsVmwareClustersEnroll(parent: string, req: EnrollVmwareClusterRequest): Promise<Operation>

[src]

Enrolls an existing VMware user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.

@param parent

Required. The parent of the project and location where the cluster is Enrolled in. Format: "projects/{project}/locations/{location}"

projectsLocationsVmwareClustersGet(name: string, opts?: ProjectsLocationsVmwareClustersGetOptions): Promise<VmwareCluster>

[src]

Gets details of a single VMware Cluster.

@param name

Required. Name of the VMware user cluster to be returned. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}"

projectsLocationsVmwareClustersGetIamPolicy(resource: string, opts?: ProjectsLocationsVmwareClustersGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsVmwareClustersList(parent: string, opts?: ProjectsLocationsVmwareClustersListOptions): Promise<ListVmwareClustersResponse>

[src]

Lists VMware Clusters in a given project and location.

@param parent

Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}"

projectsLocationsVmwareClustersOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsVmwareClustersOperationsList(name: string, opts?: ProjectsLocationsVmwareClustersOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsVmwareClustersPatch(name: string, req: VmwareCluster, opts?: ProjectsLocationsVmwareClustersPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single VMware cluster.

@param name

Immutable. The VMware user cluster resource name.

projectsLocationsVmwareClustersQueryVersionConfig(parent: string, opts?: ProjectsLocationsVmwareClustersQueryVersionConfigOptions): Promise<QueryVmwareVersionConfigResponse>

[src]

Queries the VMware user cluster version config.

@param parent

Required. The parent of the project and location to query for version config. Format: "projects/{project}/locations/{location}"

projectsLocationsVmwareClustersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsVmwareClustersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsVmwareClustersUnenroll(name: string, opts?: ProjectsLocationsVmwareClustersUnenrollOptions): Promise<Operation>

[src]

Unenrolls an existing VMware user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or UI.

@param name

Required. Name of the VMware user cluster to be unenrolled. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}"

projectsLocationsVmwareClustersVmwareNodePoolsCreate(parent: string, req: VmwareNodePool, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsCreateOptions): Promise<Operation>

[src]

Creates a new VMware node pool in a given project, location and VMWare cluster.

@param parent

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

projectsLocationsVmwareClustersVmwareNodePoolsDelete(name: string, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsDeleteOptions): Promise<Operation>

[src]

Deletes a single VMware node pool.

@param name

Required. The name of the node pool to delete. Format: projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool}

projectsLocationsVmwareClustersVmwareNodePoolsEnroll(parent: string, req: EnrollVmwareNodePoolRequest): Promise<Operation>

[src]

Enrolls a VMware node pool to Anthos On-Prem API

@param parent

Required. The parent resource where the node pool is enrolled in.

projectsLocationsVmwareClustersVmwareNodePoolsGet(name: string, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsGetOptions): Promise<VmwareNodePool>

[src]

Gets details of a single VMware node pool.

@param name

Required. The name of the node pool to retrieve. projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool}

projectsLocationsVmwareClustersVmwareNodePoolsGetIamPolicy(resource: string, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsVmwareClustersVmwareNodePoolsList(parent: string, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsListOptions): Promise<ListVmwareNodePoolsResponse>

[src]

Lists VMware node pools in a given project, location and VMWare cluster.

@param parent

Required. The parent, which owns this collection of node pools. Format: projects/{project}/locations/{location}/vmwareClusters/{vmwareCluster}

projectsLocationsVmwareClustersVmwareNodePoolsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsVmwareClustersVmwareNodePoolsOperationsList(name: string, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsVmwareClustersVmwareNodePoolsPatch(name: string, req: VmwareNodePool, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single VMware node pool.

@param name

Immutable. The resource name of this node pool.

projectsLocationsVmwareClustersVmwareNodePoolsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsVmwareClustersVmwareNodePoolsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsVmwareClustersVmwareNodePoolsUnenroll(name: string, opts?: ProjectsLocationsVmwareClustersVmwareNodePoolsUnenrollOptions): Promise<Operation>

[src]

Unenrolls a VMware node pool to Anthos On-Prem API

@param name

Required. The name of the node pool to unenroll. Format: projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool}