{ "baseUrl": "https://gkeonprem.googleapis.com/", "documentationLink": "https://cloud.google.com/anthos/clusters/docs/on-prem/", "schemas": { "VmwareAddressPool": { "description": "Represents an IP pool used by the load balancer.", "type": "object", "id": "VmwareAddressPool", "properties": { "pool": { "description": "Required. The name of the address pool.", "type": "string" }, "addresses": { "items": { "type": "string" }, "description": "Required. The addresses that are part of this pool. Each address must be either in the CIDR form (1.2.3.0/24) or range form (1.2.3.1-1.2.3.5).", "type": "array" }, "avoidBuggyIps": { "description": "If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.", "type": "boolean" }, "manualAssign": { "description": "If true, prevent IP addresses from being automatically assigned.", "type": "boolean" } } }, "VmwarePlatformConfig": { "properties": { "requiredPlatformVersion": { "description": "Input only. The required platform version e.g. 1.13.1. If the current platform version is lower than the target version, the platform version will be updated to the target version. If the target version is not installed in the platform (bundle versions), download the target version bundle.", "type": "string" }, "status": { "$ref": "ResourceStatus", "readOnly": true, "description": "Output only. Resource status for the platform." }, "platformVersion": { "description": "Output only. The platform version e.g. 1.13.2.", "type": "string", "readOnly": true }, "bundles": { "description": "Output only. The list of bundles installed in the admin cluster.", "type": "array", "readOnly": true, "items": { "$ref": "VmwareBundleConfig" } } }, "description": "VmwarePlatformConfig represents configuration for the VMware platform.", "type": "object", "id": "VmwarePlatformConfig" }, "VmwareVsphereTag": { "properties": { "category": { "description": "The Vsphere tag category.", "type": "string" }, "tag": { "description": "The Vsphere tag name.", "type": "string" } }, "description": "VmwareVsphereTag describes a vSphere tag to be placed on VMs in the node pool. For more information, see https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-E8E854DD-AA97-4E0C-8419-CE84F93C4058.html", "type": "object", "id": "VmwareVsphereTag" }, "BareMetalMaintenanceStatus": { "properties": { "machineDrainStatus": { "description": "The maintenance status of node machines.", "$ref": "BareMetalMachineDrainStatus" } }, "id": "BareMetalMaintenanceStatus", "description": "Represents the maintenance status of the bare metal user cluster.", "type": "object" }, "BareMetalAdminMaintenanceConfig": { "description": "BareMetalAdminMaintenanceConfig specifies configurations to put bare metal Admin cluster CRs nodes in and out of maintenance.", "type": "object", "id": "BareMetalAdminMaintenanceConfig", "properties": { "maintenanceAddressCidrBlocks": { "items": { "type": "string" }, "description": "Required. All IPv4 address from these ranges will be placed into maintenance mode. Nodes in maintenance mode will be cordoned and drained. When both of these are true, the \"baremetal.cluster.gke.io/maintenance\" annotation will be set on the node resource.", "type": "array" } } }, "BareMetalAdminSecurityConfig": { "properties": { "authorization": { "description": "Configures user access to the admin cluster.", "$ref": "Authorization" } }, "id": "BareMetalAdminSecurityConfig", "description": "Specifies the security related settings for the bare metal admin cluster.", "type": "object" }, "BareMetalWorkloadNodeConfig": { "properties": { "maxPodsPerNode": { "format": "int64", "description": "The maximum number of pods a node can run. The size of the CIDR range assigned to the node will be derived from this parameter.", "type": "string" }, "containerRuntime": { "enum": [ "CONTAINER_RUNTIME_UNSPECIFIED", "CONTAINERD" ], "description": "Specifies which container runtime will be used.", "type": "string", "enumDescriptions": [ "No container runtime selected.", "Containerd runtime." ] } }, "description": "Specifies the workload node configurations.", "type": "object", "id": "BareMetalWorkloadNodeConfig" }, "BareMetalAdminMaintenanceStatus": { "description": "BareMetalAdminMaintenanceStatus represents the maintenance status for bare metal Admin cluster CR's nodes.", "type": "object", "id": "BareMetalAdminMaintenanceStatus", "properties": { "machineDrainStatus": { "$ref": "BareMetalAdminMachineDrainStatus", "description": "Represents the status of draining and drained machine nodes. This is used to show the progress of cluster upgrade." } } }, "Authorization": { "id": "Authorization", "description": "Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster.", "type": "object", "properties": { "adminUsers": { "description": "For VMware and bare metal user clusters, users will be granted the cluster-admin role on the cluster, which provides full administrative access to the cluster. For bare metal admin clusters, users will be granted the cluster-view role, which limits users to read-only access.", "type": "array", "items": { "$ref": "ClusterUser" } } } }, "VmwareStorageConfig": { "properties": { "vsphereCsiDisabled": { "description": "Whether or not to deploy vSphere CSI components in the VMware user cluster. Enabled by default.", "type": "boolean" } }, "id": "VmwareStorageConfig", "description": "Specifies vSphere CSI components deployment config in the VMware user cluster.", "type": "object" }, "VmwareF5BigIpConfig": { "description": "Represents configuration parameters for an F5 BIG-IP load balancer.", "type": "object", "id": "VmwareF5BigIpConfig", "properties": { "partition": { "description": "The preexisting partition to be used by the load balancer. This partition is usually created for the admin cluster for example: 'my-f5-admin-partition'.", "type": "string" }, "address": { "description": "The load balancer's IP address.", "type": "string" }, "snatPool": { "description": "The pool name. Only necessary, if using SNAT.", "type": "string" } } }, "ResourceCondition": { "description": "ResourceCondition provides a standard mechanism for higher-level status reporting from controller.", "type": "object", "id": "ResourceCondition", "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "STATE_TRUE", "STATE_FALSE", "STATE_UNKNOWN" ], "description": "state of the condition.", "type": "string", "enumDescriptions": [ "Not set.", "Resource is in the condition.", "Resource is not in the condition.", "Kubernetes controller can't decide if the resource is in the condition or not." ] }, "type": { "description": "Type of the condition. (e.g., ClusterRunning, NodePoolRunning or ServerSidePreflightReady)", "type": "string" }, "message": { "description": "Human-readable message indicating details about last transition.", "type": "string" }, "lastTransitionTime": { "format": "google-datetime", "description": "Last time the condition transit from one status to another.", "type": "string" }, "reason": { "description": "Machine-readable message indicating details about last transition.", "type": "string" } } }, "VmwareHostConfig": { "properties": { "dnsServers": { "description": "DNS servers.", "type": "array", "items": { "type": "string" } }, "ntpServers": { "items": { "type": "string" }, "description": "NTP servers.", "type": "array" }, "dnsSearchDomains": { "description": "DNS search domains.", "type": "array", "items": { "type": "string" } } }, "id": "VmwareHostConfig", "description": "Represents the common parameters for all the hosts irrespective of their IP address.", "type": "object" }, "BareMetalNodeAccessConfig": { "properties": { "loginUser": { "description": "LoginUser is the user name used to access node machines. It defaults to \"root\" if not set.", "type": "string" } }, "id": "BareMetalNodeAccessConfig", "description": "Specifies the node access related settings for the bare metal user cluster.", "type": "object" }, "BareMetalAdminControlPlaneConfig": { "id": "BareMetalAdminControlPlaneConfig", "description": "BareMetalAdminControlPlaneConfig specifies the control plane configuration.", "type": "object", "properties": { "controlPlaneNodePoolConfig": { "$ref": "BareMetalAdminControlPlaneNodePoolConfig", "description": "Required. Configures the node pool running the control plane. If specified the corresponding NodePool will be created for the cluster's control plane. The NodePool will have the same name and namespace as the cluster." }, "apiServerArgs": { "description": "Customizes the default API server args. Only a subset of customized flags are supported. Please refer to the API server documentation below to know the exact format: https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/", "type": "array", "items": { "$ref": "BareMetalAdminApiServerArgument" } } } }, "BareMetalAdminDrainedMachine": { "id": "BareMetalAdminDrainedMachine", "description": "BareMetalAdminDrainedMachine represents the machines that are drained.", "type": "object", "properties": { "nodeIp": { "description": "Drained machine IP address.", "type": "string" } } }, "BareMetalSrIovConfig": { "id": "BareMetalSrIovConfig", "description": "Specifies the SR-IOV networking operator config.", "type": "object", "properties": { "enabled": { "description": "Whether to install the SR-IOV operator.", "type": "boolean" } } }, "ListBareMetalAdminClustersResponse": { "properties": { "bareMetalAdminClusters": { "description": "The list of bare metal admin cluster.", "type": "array", "items": { "$ref": "BareMetalAdminCluster" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return. If the token is not empty this means that more results are available and should be retrieved by repeating the request with the provided page token.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } }, "id": "ListBareMetalAdminClustersResponse", "description": "Response message for listing bare metal admin clusters.", "type": "object" }, "BareMetalApiServerArgument": { "id": "BareMetalApiServerArgument", "description": "Represents an arg name-\u003evalue pair. Only a subset of customized flags are supported. For the exact format, refer to the [API server documentation](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).", "type": "object", "properties": { "argument": { "description": "Required. The argument name as it appears on the API Server command line, make sure to remove the leading dashes.", "type": "string" }, "value": { "description": "Required. The value of the arg as it will be passed to the API Server command line.", "type": "string" } } }, "BareMetalAdminIslandModeCidrConfig": { "properties": { "serviceAddressCidrBlocks": { "description": "Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field cannot be changed after creation.", "type": "array", "items": { "type": "string" } }, "podAddressCidrBlocks": { "items": { "type": "string" }, "description": "Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field cannot be changed after creation.", "type": "array" } }, "description": "BareMetalAdminIslandModeCidrConfig specifies the cluster CIDR configuration while running in island mode.", "type": "object", "id": "BareMetalAdminIslandModeCidrConfig" }, "VmwareAdminControlPlaneNodeConfig": { "description": "VmwareAdminControlPlaneNodeConfig contains control plane node configuration for VMware admin cluster.", "type": "object", "id": "VmwareAdminControlPlaneNodeConfig", "properties": { "memory": { "description": "The number of mebibytes of memory for the control-plane node of the admin cluster.", "type": "string", "format": "int64" }, "replicas": { "format": "int64", "description": "The number of control plane nodes for this VMware admin cluster. (default: 1 replica).", "type": "string" }, "cpus": { "format": "int64", "description": "The number of vCPUs for the control-plane node of the admin cluster.", "type": "string" } } }, "VmwareVCenterConfig": { "description": "Represents configuration for the VMware VCenter for the user cluster.", "type": "object", "id": "VmwareVCenterConfig", "properties": { "address": { "description": "Output only. The vCenter IP address.", "type": "string", "readOnly": true }, "datacenter": { "description": "The name of the vCenter datacenter for the user cluster.", "type": "string" }, "cluster": { "description": "The name of the vCenter cluster for the user cluster.", "type": "string" }, "caCertData": { "description": "Contains the vCenter CA certificate public key for SSL verification.", "type": "string" }, "datastore": { "description": "The name of the vCenter datastore for the user cluster.", "type": "string" }, "storagePolicyName": { "description": "The name of the vCenter storage policy for the user cluster.", "type": "string" }, "folder": { "description": "The name of the vCenter folder for the user cluster.", "type": "string" }, "resourcePool": { "description": "The name of the vCenter resource pool for the user cluster.", "type": "string" } } }, "BareMetalAdminControlPlaneNodePoolConfig": { "id": "BareMetalAdminControlPlaneNodePoolConfig", "description": "BareMetalAdminControlPlaneNodePoolConfig specifies the control plane node pool configuration. We have a control plane specific node pool config so that we can flexible about supporting control plane specific fields in the future.", "type": "object", "properties": { "nodePoolConfig": { "description": "Required. The generic configuration for a node pool running the control plane.", "$ref": "BareMetalNodePoolConfig" } } }, "BareMetalAdminLoadBalancerConfig": { "properties": { "vipConfig": { "description": "The VIPs used by the load balancer.", "$ref": "BareMetalAdminVipConfig" }, "manualLbConfig": { "$ref": "BareMetalAdminManualLbConfig", "description": "Manually configured load balancers." }, "portConfig": { "$ref": "BareMetalAdminPortConfig", "description": "Configures the ports that the load balancer will listen on." }, "bgpLbConfig": { "$ref": "BareMetalAdminBgpLbConfig", "description": "Configuration for BGP typed load balancers." } }, "id": "BareMetalAdminLoadBalancerConfig", "description": "BareMetalAdminLoadBalancerConfig specifies the load balancer configuration.", "type": "object" }, "BareMetalMaintenanceConfig": { "properties": { "maintenanceAddressCidrBlocks": { "items": { "type": "string" }, "description": "Required. All IPv4 address from these ranges will be placed into maintenance mode. Nodes in maintenance mode will be cordoned and drained. When both of these are true, the \"baremetal.cluster.gke.io/maintenance\" annotation will be set on the node resource.", "type": "array" } }, "description": "Specifies configurations to put bare metal nodes in and out of maintenance.", "type": "object", "id": "BareMetalMaintenanceConfig" }, "VmwareVsphereConfig": { "properties": { "datastore": { "description": "The name of the vCenter datastore. Inherited from the user cluster.", "type": "string" }, "hostGroups": { "description": "Vsphere host groups to apply to all VMs in the node pool", "type": "array", "items": { "type": "string" } }, "tags": { "description": "Tags to apply to VMs.", "type": "array", "items": { "$ref": "VmwareVsphereTag" } } }, "id": "VmwareVsphereConfig", "description": "VmwareVsphereConfig represents configuration for the VMware VCenter for node pool.", "type": "object" }, "BareMetalNodePoolConfig": { "id": "BareMetalNodePoolConfig", "description": "BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool.", "type": "object", "properties": { "operatingSystem": { "enum": [ "OPERATING_SYSTEM_UNSPECIFIED", "LINUX" ], "enumDescriptions": [ "No operating system runtime selected.", "Linux operating system." ], "description": "Specifies the nodes operating system (default: LINUX).", "type": "string" }, "kubeletConfig": { "description": "The modifiable kubelet configurations for the bare metal machines.", "$ref": "BareMetalKubeletConfig" }, "labels": { "additionalProperties": { "type": "string" }, "description": "The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }.", "type": "object" }, "nodeConfigs": { "items": { "$ref": "BareMetalNodeConfig" }, "description": "Required. The list of machine addresses in the bare metal node pool.", "type": "array" }, "taints": { "items": { "$ref": "NodeTaint" }, "description": "The initial taints assigned to nodes of this node pool.", "type": "array" } } }, "BareMetalAdminProxyConfig": { "properties": { "uri": { "description": "Required. Specifies the address of your proxy server. Examples: `http://domain` WARNING: Do not provide credentials in the format `http://(username:password@)domain` these will be rejected by the server.", "type": "string" }, "noProxy": { "items": { "type": "string" }, "description": "A list of IPs, hostnames, and domains that should skip the proxy. Examples: [\"127.0.0.1\", \"example.com\", \".corp\", \"localhost\"].", "type": "array" } }, "description": "BareMetalAdminProxyConfig specifies the cluster proxy configuration.", "type": "object", "id": "BareMetalAdminProxyConfig" }, "BareMetalVersionInfo": { "properties": { "version": { "description": "Version number e.g. 1.13.1.", "type": "string" }, "hasDependencies": { "description": "If set, the cluster dependencies (e.g. the admin cluster, other user clusters managed by the same admin cluster, version skew policy, etc) must be upgraded before this version can be installed or upgraded to.", "type": "boolean" }, "dependencies": { "items": { "$ref": "UpgradeDependency" }, "description": "The list of upgrade dependencies for this version.", "type": "array" } }, "description": "Contains information about a specific Anthos on bare metal version.", "type": "object", "id": "BareMetalVersionInfo" }, "BareMetalAdminDrainingMachine": { "properties": { "podCount": { "format": "int32", "description": "The count of pods yet to drain.", "type": "integer" }, "nodeIp": { "description": "Draining machine IP address.", "type": "string" } }, "id": "BareMetalAdminDrainingMachine", "description": "BareMetalAdminDrainingMachine represents the machines that are currently draining.", "type": "object" }, "VmwareNodePoolAutoscalingConfig": { "properties": { "maxReplicas": { "description": "Maximum number of replicas in the NodePool.", "type": "integer", "format": "int32" }, "minReplicas": { "format": "int32", "description": "Minimum number of replicas in the NodePool.", "type": "integer" } }, "description": "NodePoolAutoscaling config for the NodePool to allow for the kubernetes to scale NodePool.", "type": "object", "id": "VmwareNodePoolAutoscalingConfig" }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object" }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" } } }, "BareMetalLoadBalancerNodePoolConfig": { "properties": { "nodePoolConfig": { "description": "The generic configuration for a node pool running a load balancer.", "$ref": "BareMetalNodePoolConfig" } }, "id": "BareMetalLoadBalancerNodePoolConfig", "description": "Specifies the load balancer's node pool configuration.", "type": "object" }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "id": "Status", "properties": { "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array" }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" } } }, "BareMetalIslandModeCidrConfig": { "id": "BareMetalIslandModeCidrConfig", "description": "Specifies the cluster CIDR configuration while running in island mode.", "type": "object", "properties": { "serviceAddressCidrBlocks": { "items": { "type": "string" }, "description": "Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field is mutable after creation starting with version 1.15.", "type": "array" }, "podAddressCidrBlocks": { "description": "Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field cannot be changed after creation.", "type": "array", "items": { "type": "string" } } } }, "BareMetalVipConfig": { "description": "Specifies the VIP config for the bare metal load balancer.", "type": "object", "id": "BareMetalVipConfig", "properties": { "controlPlaneVip": { "description": "The VIP which you previously set aside for the Kubernetes API of this bare metal user cluster.", "type": "string" }, "ingressVip": { "description": "The VIP which you previously set aside for ingress traffic into this bare metal user cluster.", "type": "string" } } }, "VmwareAdminProxy": { "description": "VmwareAdminProxy represents configuration for admin cluster proxy.", "type": "object", "id": "VmwareAdminProxy", "properties": { "url": { "description": "The HTTP address of proxy server.", "type": "string" }, "noProxy": { "description": "A comma-separated list of IP addresses, IP address ranges, host names, and domain names that should not go through the proxy server. When Google Distributed Cloud sends a request to one of these addresses, hosts, or domains, the request is sent directly.", "type": "string" } } }, "VmwareBundleConfig": { "description": "VmwareBundleConfig represents configuration for the bundle.", "type": "object", "id": "VmwareBundleConfig", "properties": { "version": { "description": "The version of the bundle.", "type": "string" }, "status": { "readOnly": true, "description": "Output only. Resource status for the bundle.", "$ref": "ResourceStatus" } } }, "Empty": { "properties": {}, "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "id": "Empty" }, "OperationMetadata": { "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "type": "object", "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "apiVersion": { "description": "Output only. API version used to start the operation.", "type": "string", "readOnly": true }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error] value with a [google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.", "type": "boolean", "readOnly": true }, "progress": { "readOnly": true, "description": "Output only. Detailed progress information for the operation.", "$ref": "OperationProgress" }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "type": "string", "readOnly": true }, "controlPlaneDisconnected": { "readOnly": true, "description": "Output only. Denotes if the local managing cluster's control plane is currently disconnected. This is expected to occur temporarily during self-managed cluster upgrades.", "type": "boolean" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "type": "string", "readOnly": true }, "type": { "readOnly": true, "enumDescriptions": [ "Not set.", "The resource is being created.", "The resource is being deleted.", "The resource is being updated.", "The resource is being upgraded.", "The platform is being upgraded." ], "enum": [ "OPERATION_TYPE_UNSPECIFIED", "CREATE", "DELETE", "UPDATE", "UPGRADE", "PLATFORM_UPGRADE" ], "description": "Output only. Type of operation being executed.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "type": "string", "readOnly": true } } }, "BareMetalAdminApiServerArgument": { "description": "BareMetalAdminApiServerArgument represents an arg name-\u003evalue pair. Only a subset of customized flags are supported. Please refer to the API server documentation below to know the exact format: https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/", "type": "object", "id": "BareMetalAdminApiServerArgument", "properties": { "argument": { "description": "Required. The argument name as it appears on the API Server command line please make sure to remove the leading dashes.", "type": "string" }, "value": { "description": "Required. The value of the arg as it will be passed to the API Server command line.", "type": "string" } } }, "BareMetalStorageConfig": { "id": "BareMetalStorageConfig", "description": "BareMetalStorageConfig specifies the cluster storage configuration.", "type": "object", "properties": { "lvpShareConfig": { "$ref": "BareMetalLvpShareConfig", "description": "Required. Specifies the config for local PersistentVolumes backed by subdirectories in a shared filesystem. These subdirectores are automatically created during cluster creation." }, "lvpNodeMountsConfig": { "$ref": "BareMetalLvpConfig", "description": "Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation." } } }, "VmwareVersionInfo": { "id": "VmwareVersionInfo", "description": "Contains information about a specific Anthos on VMware version.", "type": "object", "properties": { "dependencies": { "description": "The list of upgrade dependencies for this version.", "type": "array", "items": { "$ref": "UpgradeDependency" } }, "hasDependencies": { "description": "If set, the cluster dependencies (e.g. the admin cluster, other user clusters managed by the same admin cluster) must be upgraded before this version can be installed or upgraded to.", "type": "boolean" }, "version": { "description": "Version number e.g. 1.13.1-gke.1000.", "type": "string" }, "isInstalled": { "description": "If set, the version is installed in the admin cluster. Otherwise, the version bundle must be downloaded and installed before a user cluster can be created at or upgraded to this version.", "type": "boolean" } } }, "EnrollVmwareClusterRequest": { "properties": { "validateOnly": { "description": "Validate the request without actually doing any updates.", "type": "boolean" }, "localName": { "description": "Optional. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting resource names when enrolling existing clusters to the API. When not provided, this field will resolve to the vmware_cluster_id. Otherwise, it must match the object name of the VMware OnPremUserCluster custom resource. It is not modifiable outside / beyond the enrollment operation.", "type": "string" }, "vmwareClusterId": { "description": "User provided OnePlatform identifier that is used as part of the resource name. This must be unique among all GKE on-prem clusters within a project and location and will return a 409 if the cluster already exists. (https://tools.ietf.org/html/rfc1123) format.", "type": "string" }, "adminClusterMembership": { "description": "Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources.", "type": "string" } }, "id": "EnrollVmwareClusterRequest", "description": "Message for enrolling an existing VMware cluster to the Anthos On-Prem API.", "type": "object" }, "BareMetalNodePoolUpgradePolicy": { "properties": { "parallelUpgradeConfig": { "description": "The parallel upgrade settings for worker node pools.", "$ref": "BareMetalParallelUpgradeConfig" } }, "id": "BareMetalNodePoolUpgradePolicy", "description": "BareMetalNodePoolUpgradePolicy defines the node pool upgrade policy.", "type": "object" }, "VmwareAdminLoadBalancerConfig": { "properties": { "vipConfig": { "$ref": "VmwareAdminVipConfig", "description": "The VIPs used by the load balancer." }, "metalLbConfig": { "description": "MetalLB load balancers.", "$ref": "VmwareAdminMetalLbConfig" }, "manualLbConfig": { "description": "Manually configured load balancers.", "$ref": "VmwareAdminManualLbConfig" }, "seesawConfig": { "description": "Output only. Configuration for Seesaw typed load balancers.", "readOnly": true, "$ref": "VmwareAdminSeesawConfig" }, "f5Config": { "description": "Configuration for F5 Big IP typed load balancers.", "$ref": "VmwareAdminF5BigIpConfig" } }, "id": "VmwareAdminLoadBalancerConfig", "description": "VmwareAdminLoadBalancerConfig contains load balancer configuration for VMware admin cluster.", "type": "object" }, "VmwareControlPlaneV2Config": { "description": "Specifies control plane V2 config.", "type": "object", "id": "VmwareControlPlaneV2Config", "properties": { "controlPlaneIpBlock": { "description": "Static IP addresses for the control plane nodes.", "$ref": "VmwareIpBlock" } } }, "VmwareDataplaneV2Config": { "id": "VmwareDataplaneV2Config", "description": "Contains configurations for Dataplane V2, which is optimized dataplane for Kubernetes networking. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dataplane-v2", "type": "object", "properties": { "advancedNetworking": { "description": "Enable advanced networking which requires dataplane_v2_enabled to be set true.", "type": "boolean" }, "forwardMode": { "description": "Configure ForwardMode for Dataplane v2.", "type": "string" }, "windowsDataplaneV2Enabled": { "description": "Enable Dataplane V2 for clusters with Windows nodes.", "type": "boolean" }, "dataplaneV2Enabled": { "description": "Enables Dataplane V2.", "type": "boolean" } } }, "VmwareAdminF5BigIpConfig": { "properties": { "partition": { "description": "The preexisting partition to be used by the load balancer. This partition is usually created for the admin cluster for example: 'my-f5-admin-partition'.", "type": "string" }, "snatPool": { "description": "The pool name. Only necessary, if using SNAT.", "type": "string" }, "address": { "description": "The load balancer's IP address.", "type": "string" } }, "id": "VmwareAdminF5BigIpConfig", "description": "VmwareAdminF5BigIpConfig represents configuration parameters for an F5 BIG-IP load balancer.", "type": "object" }, "Operation": { "properties": { "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" } }, "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object" }, "VmwareAdminAuthorizationConfig": { "properties": { "viewerUsers": { "items": { "$ref": "ClusterUser" }, "description": "For VMware admin clusters, users will be granted the cluster-viewer role on the cluster.", "type": "array" } }, "id": "VmwareAdminAuthorizationConfig", "description": "VmwareAdminAuthorizationConfig represents configuration for admin cluster authorization.", "type": "object" }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { "locations": { "items": { "$ref": "Location" }, "description": "A list of locations that matches the specified filter in the request.", "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "VmwareAdminManualLbConfig": { "properties": { "ingressHttpNodePort": { "description": "NodePort for ingress service's http. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 32527).", "type": "integer", "format": "int32" }, "ingressHttpsNodePort": { "description": "NodePort for ingress service's https. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 30139).", "type": "integer", "format": "int32" }, "controlPlaneNodePort": { "format": "int32", "description": "NodePort for control plane service. The Kubernetes API server in the admin cluster is implemented as a Service of type NodePort (ex. 30968).", "type": "integer" }, "konnectivityServerNodePort": { "format": "int32", "description": "NodePort for konnectivity server service running as a sidecar in each kube-apiserver pod (ex. 30564).", "type": "integer" }, "addonsNodePort": { "format": "int32", "description": "NodePort for add-ons server in the admin cluster.", "type": "integer" } }, "id": "VmwareAdminManualLbConfig", "type": "object" }, "ListVmwareAdminClustersResponse": { "description": "Response message for listing VMware admin clusters.", "type": "object", "id": "ListVmwareAdminClustersResponse", "properties": { "vmwareAdminClusters": { "items": { "$ref": "VmwareAdminCluster" }, "description": "The list of VMware admin cluster.", "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return. If the token is not empty this means that more results are available and should be retrieved by repeating the request with the provided page token.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } } }, "VmwareCluster": { "id": "VmwareCluster", "description": "Resource that represents a VMware user cluster. ##", "type": "object", "properties": { "description": { "description": "A human readable description of this VMware user cluster.", "type": "string" }, "loadBalancer": { "$ref": "VmwareLoadBalancerConfig", "description": "Load balancer configuration." }, "deleteTime": { "description": "Output only. The time at which VMware user cluster was deleted.", "type": "string", "readOnly": true, "format": "google-datetime" }, "status": { "$ref": "ResourceStatus", "description": "Output only. ResourceStatus representing detailed cluster state.", "readOnly": true }, "name": { "description": "Immutable. The VMware user cluster resource name.", "type": "string" }, "adminClusterMembership": { "description": "Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources.", "type": "string" }, "enableControlPlaneV2": { "description": "Enable control plane V2. Default to false.", "type": "boolean" }, "state": { "readOnly": true, "enumDescriptions": [ "Not set.", "The PROVISIONING state indicates the cluster is being created.", "The RUNNING state indicates the cluster has been created and is fully usable.", "The RECONCILING state indicates that the cluster is being updated. It remains available, but potentially with degraded performance.", "The STOPPING state indicates the cluster is being deleted.", "The ERROR state indicates the cluster is in a broken unrecoverable state.", "The DEGRADED state indicates the cluster requires user action to restore full functionality." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "RUNNING", "RECONCILING", "STOPPING", "ERROR", "DEGRADED" ], "description": "Output only. The current state of VMware user cluster.", "type": "string" }, "fleet": { "$ref": "Fleet", "description": "Output only. Fleet configuration for the cluster.", "readOnly": true }, "controlPlaneNode": { "description": "VMware user cluster control plane nodes must have either 1 or 3 replicas.", "$ref": "VmwareControlPlaneNodeConfig" }, "storage": { "$ref": "VmwareStorageConfig", "description": "Storage configuration." }, "etag": { "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.", "type": "string" }, "networkConfig": { "description": "The VMware user cluster network configuration.", "$ref": "VmwareNetworkConfig" }, "updateTime": { "description": "Output only. The time at which VMware user cluster was last updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "reconciling": { "description": "Output only. If set, there are currently changes in flight to the VMware user cluster.", "type": "boolean", "readOnly": true }, "endpoint": { "readOnly": true, "description": "Output only. The DNS name of VMware user cluster's API server.", "type": "string" }, "vmTrackingEnabled": { "description": "Enable VM tracking.", "type": "boolean" }, "adminClusterName": { "description": "Output only. The resource name of the VMware admin cluster hosting this user cluster.", "type": "string", "readOnly": true }, "binaryAuthorization": { "description": "Binary Authorization related configurations.", "$ref": "BinaryAuthorization" }, "disableBundledIngress": { "description": "Disable bundled ingress.", "type": "boolean" }, "uid": { "readOnly": true, "description": "Output only. The unique identifier of the VMware user cluster.", "type": "string" }, "dataplaneV2": { "description": "VmwareDataplaneV2Config specifies configuration for Dataplane V2.", "$ref": "VmwareDataplaneV2Config" }, "localName": { "description": "Output only. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs.", "type": "string", "readOnly": true }, "annotations": { "description": "Annotations on the VMware user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.", "type": "object", "additionalProperties": { "type": "string" } }, "validationCheck": { "description": "Output only. ValidationCheck represents the result of the preflight check job.", "readOnly": true, "$ref": "ValidationCheck" }, "upgradePolicy": { "$ref": "VmwareClusterUpgradePolicy", "description": "Specifies upgrade policy for the cluster." }, "antiAffinityGroups": { "description": "AAGConfig specifies whether to spread VMware user cluster nodes across at least three physical hosts in the datacenter.", "$ref": "VmwareAAGConfig" }, "vcenter": { "description": "VmwareVCenterConfig specifies vCenter config for the user cluster. If unspecified, it is inherited from the admin cluster.", "$ref": "VmwareVCenterConfig" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which VMware user cluster was created.", "type": "string" }, "onPremVersion": { "description": "Required. The Anthos clusters on the VMware version for your user cluster.", "type": "string" }, "autoRepairConfig": { "description": "Configuration for auto repairing.", "$ref": "VmwareAutoRepairConfig" }, "authorization": { "$ref": "Authorization", "description": "RBAC policy that will be applied and managed by the Anthos On-Prem API." }, "enableAdvancedCluster": { "description": "Enable advanced cluster.", "type": "boolean" } } }, "BareMetalMultipleNetworkInterfacesConfig": { "properties": { "enabled": { "description": "Whether to enable multiple network interfaces for your pods. When set network_config.advanced_networking is automatically set to true.", "type": "boolean" } }, "description": "Specifies the multiple networking interfaces cluster configuration.", "type": "object", "id": "BareMetalMultipleNetworkInterfacesConfig" }, "VmwareNetworkConfig": { "description": "Specifies network config for the VMware user cluster.", "type": "object", "id": "VmwareNetworkConfig", "properties": { "podAddressCidrBlocks": { "description": "Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.", "type": "array", "items": { "type": "string" } }, "vcenterNetwork": { "description": "vcenter_network specifies vCenter network name. Inherited from the admin cluster.", "type": "string" }, "serviceAddressCidrBlocks": { "description": "Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.", "type": "array", "items": { "type": "string" } }, "hostConfig": { "description": "Represents common network settings irrespective of the host's IP address.", "$ref": "VmwareHostConfig" }, "controlPlaneV2Config": { "description": "Configuration for control plane V2 mode.", "$ref": "VmwareControlPlaneV2Config" }, "dhcpIpConfig": { "$ref": "VmwareDhcpIpConfig", "description": "Configuration settings for a DHCP IP configuration." }, "staticIpConfig": { "description": "Configuration settings for a static IP configuration.", "$ref": "VmwareStaticIpConfig" } } }, "TestIamPermissionsRequest": { "properties": { "permissions": { "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "type": "array", "items": { "type": "string" } } }, "id": "TestIamPermissionsRequest", "description": "Request message for `TestIamPermissions` method.", "type": "object" }, "BareMetalMachineDrainStatus": { "properties": { "drainingMachines": { "items": { "$ref": "BareMetalDrainingMachine" }, "description": "The list of draning machines.", "type": "array" }, "drainedMachines": { "description": "The list of drained machines.", "type": "array", "items": { "$ref": "BareMetalDrainedMachine" } } }, "id": "BareMetalMachineDrainStatus", "description": "Represents the status of node machines that are undergoing drain operations.", "type": "object" }, "OperationStage": { "properties": { "state": { "description": "Output only. State of the stage.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED" ], "readOnly": true, "enumDescriptions": [ "Not set.", "The stage is pending.", "The stage is running", "The stage has completed successfully.", "The stage has failed." ] }, "stage": { "enumDescriptions": [ "Not set.", "Preflight checks are running.", "Resource is being configured.", "Resource is being deployed.", "Waiting for the resource to become healthy.", "Resource is being updated." ], "description": "The high-level stage of the operation.", "type": "string", "enum": [ "STAGE_UNSPECIFIED", "PREFLIGHT_CHECK", "CONFIGURE", "DEPLOY", "HEALTH_CHECK", "UPDATE" ] }, "endTime": { "description": "Time the stage ended.", "type": "string", "format": "google-datetime" }, "metrics": { "description": "Progress metric bundle.", "type": "array", "items": { "$ref": "Metric" } }, "startTime": { "format": "google-datetime", "description": "Time the stage started.", "type": "string" } }, "id": "OperationStage", "description": "Information about a particular stage of an operation.", "type": "object" }, "BareMetalParallelUpgradeConfig": { "description": "BareMetalParallelUpgradeConfig defines the parallel upgrade settings for worker node pools.", "type": "object", "id": "BareMetalParallelUpgradeConfig", "properties": { "minimumAvailableNodes": { "format": "int32", "description": "The minimum number of nodes that should be healthy and available during an upgrade. If set to the default value of 0, it is possible that none of the nodes will be available during an upgrade.", "type": "integer" }, "concurrentNodes": { "format": "int32", "description": "The maximum number of nodes that can be upgraded at once.", "type": "integer" } } }, "BareMetalDrainingMachine": { "properties": { "podCount": { "format": "int32", "description": "The count of pods yet to drain.", "type": "integer" }, "nodeIp": { "description": "Draining machine IP address.", "type": "string" } }, "description": "Represents a machine that is currently draining.", "type": "object", "id": "BareMetalDrainingMachine" }, "ValidationCheckResult": { "id": "ValidationCheckResult", "description": "ValidationCheckResult defines the details about the validation check.", "type": "object", "properties": { "details": { "description": "Detailed failure information, which might be unformatted.", "type": "string" }, "state": { "enum": [ "STATE_UNKNOWN", "STATE_FAILURE", "STATE_SKIPPED", "STATE_FATAL", "STATE_WARNING" ], "description": "The validation check state.", "type": "string", "enumDescriptions": [ "The default value. The check result is unknown.", "The check failed.", "The check was skipped.", "The check itself failed to complete.", "The check encountered a warning." ] }, "description": { "description": "The description of the validation check.", "type": "string" }, "reason": { "description": "A human-readable message of the check failure.", "type": "string" }, "category": { "description": "The category of the validation.", "type": "string" } } }, "VmwareAAGConfig": { "properties": { "aagConfigDisabled": { "description": "Spread nodes across at least three physical hosts (requires at least three hosts). Enabled by default.", "type": "boolean" } }, "description": "Specifies anti affinity group config for the VMware user cluster.", "type": "object", "id": "VmwareAAGConfig" }, "BareMetalLvpConfig": { "properties": { "storageClass": { "description": "Required. The StorageClass name that PVs will be created with.", "type": "string" }, "path": { "description": "Required. The host machine path.", "type": "string" } }, "id": "BareMetalLvpConfig", "description": "Specifies the configs for local persistent volumes (PVs).", "type": "object" }, "ListBareMetalClustersResponse": { "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return. If the token is not empty this means that more results are available and should be retrieved by repeating the request with the provided page token.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "bareMetalClusters": { "description": "The list of bare metal Clusters.", "type": "array", "items": { "$ref": "BareMetalCluster" } } }, "description": "Response message for listing bare metal Clusters.", "type": "object", "id": "ListBareMetalClustersResponse" }, "VmwareVipConfig": { "description": "Specifies the VIP config for the VMware user cluster load balancer.", "type": "object", "id": "VmwareVipConfig", "properties": { "controlPlaneVip": { "description": "The VIP which you previously set aside for the Kubernetes API of this cluster.", "type": "string" }, "ingressVip": { "description": "The VIP which you previously set aside for ingress traffic into this cluster.", "type": "string" } } }, "Metric": { "properties": { "doubleValue": { "format": "double", "description": "For metrics with floating point value.", "type": "number" }, "metric": { "enumDescriptions": [ "Not set.", "The total number of nodes being actuated.", "The number of nodes draining.", "The number of nodes actively upgrading.", "The number of nodes to be upgraded.", "The number of nodes upgraded.", "The number of nodes to fail actuation.", "The number of nodes healthy.", "The number of nodes reconciling.", "The number of nodes in maintenance mode.", "The number of completed preflight checks.", "The number of preflight checks running.", "The number of preflight checks failed.", "The total number of preflight checks." ], "description": "Required. The metric name.", "type": "string", "enum": [ "METRIC_ID_UNSPECIFIED", "NODES_TOTAL", "NODES_DRAINING", "NODES_UPGRADING", "NODES_PENDING_UPGRADE", "NODES_UPGRADED", "NODES_FAILED", "NODES_HEALTHY", "NODES_RECONCILING", "NODES_IN_MAINTENANCE", "PREFLIGHTS_COMPLETED", "PREFLIGHTS_RUNNING", "PREFLIGHTS_FAILED", "PREFLIGHTS_TOTAL" ] }, "stringValue": { "description": "For metrics with custom values (ratios, visual progress, etc.).", "type": "string" }, "intValue": { "format": "int64", "description": "For metrics with integer value.", "type": "string" } }, "id": "Metric", "description": "Progress metric is (string, int|float|string) pair.", "type": "object" }, "BareMetalLoadBalancerAddressPool": { "properties": { "manualAssign": { "description": "If true, prevent IP addresses from being automatically assigned.", "type": "boolean" }, "pool": { "description": "Required. The name of the address pool.", "type": "string" }, "addresses": { "items": { "type": "string" }, "description": "Required. The addresses that are part of this pool. Each address must be either in the CIDR form (1.2.3.0/24) or range form (1.2.3.1-1.2.3.5).", "type": "array" }, "avoidBuggyIps": { "description": "If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.", "type": "boolean" } }, "id": "BareMetalLoadBalancerAddressPool", "description": "Represents an IP pool used by the load balancer.", "type": "object" }, "QueryBareMetalAdminVersionConfigResponse": { "properties": { "versions": { "items": { "$ref": "BareMetalVersionInfo" }, "description": "List of available versions to install or to upgrade to.", "type": "array" } }, "description": "Response message for querying bare metal admin cluster version config.", "type": "object", "id": "QueryBareMetalAdminVersionConfigResponse" }, "Versions": { "properties": { "versions": { "items": { "$ref": "Version" }, "description": "Shows the mapping of a given version to the number of machines under this version.", "type": "array" } }, "id": "Versions", "description": "Versions describes the mapping of a given version to the number of machines under this version.", "type": "object" }, "VmwareAdminPreparedSecretsConfig": { "description": "VmwareAdminPreparedSecretsConfig represents configuration for admin cluster prepared secrets.", "type": "object", "id": "VmwareAdminPreparedSecretsConfig", "properties": { "enabled": { "description": "Whether prepared secrets is enabled.", "type": "boolean" } } }, "Binding": { "properties": { "role": { "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" }, "members": { "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "type": "array", "items": { "type": "string" } }, "condition": { "$ref": "Expr", "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." } }, "description": "Associates `members`, or principals, with a `role`.", "type": "object", "id": "Binding" }, "EnrollVmwareAdminClusterRequest": { "properties": { "vmwareAdminClusterId": { "description": "User provided OnePlatform identifier that is used as part of the resource name. This must be unique among all GKE on-prem clusters within a project and location and will return a 409 if the cluster already exists. (https://tools.ietf.org/html/rfc1123) format.", "type": "string" }, "membership": { "description": "Required. This is the full resource name of this admin cluster's fleet membership.", "type": "string" } }, "id": "EnrollVmwareAdminClusterRequest", "description": "Message for enrolling an existing VMware admin cluster to the GKE on-prem API.", "type": "object" }, "BareMetalAdminPortConfig": { "properties": { "controlPlaneLoadBalancerPort": { "description": "The port that control plane hosted load balancers will listen on.", "type": "integer", "format": "int32" } }, "description": "BareMetalAdminPortConfig is the specification of load balancer ports.", "type": "object", "id": "BareMetalAdminPortConfig" }, "Version": { "description": "Version describes the number of nodes at a given version under a resource.", "type": "object", "id": "Version", "properties": { "version": { "description": "Resource version.", "type": "string" }, "count": { "format": "int64", "description": "Number of machines under the above version.", "type": "string" } } }, "ClusterUser": { "properties": { "username": { "description": "Required. The name of the user, e.g. `my-gcp-id@gmail.com`.", "type": "string" } }, "description": "ClusterUser configures user principals for an RBAC policy.", "type": "object", "id": "ClusterUser" }, "ValidationCheckStatus": { "description": "ValidationCheckStatus defines the detailed validation check status.", "type": "object", "id": "ValidationCheckStatus", "properties": { "result": { "items": { "$ref": "ValidationCheckResult" }, "description": "Individual checks which failed as part of the Preflight check execution.", "type": "array" } } }, "VmwareAdminVipConfig": { "description": "VmwareAdminVipConfig for VMware load balancer configurations.", "type": "object", "id": "VmwareAdminVipConfig", "properties": { "addonsVip": { "description": "The VIP to configure the load balancer for add-ons.", "type": "string" }, "controlPlaneVip": { "description": "The VIP which you previously set aside for the Kubernetes API of the admin cluster.", "type": "string" } } }, "BareMetalClusterOperationsConfig": { "description": "Specifies the bare metal user cluster's observability infrastructure.", "type": "object", "id": "BareMetalClusterOperationsConfig", "properties": { "enableApplicationLogs": { "description": "Whether collection of application logs/metrics should be enabled (in addition to system logs/metrics).", "type": "boolean" } } }, "BareMetalOsEnvironmentConfig": { "id": "BareMetalOsEnvironmentConfig", "description": "Specifies operating system settings for cluster provisioning.", "type": "object", "properties": { "packageRepoExcluded": { "description": "Whether the package repo should not be included when initializing bare metal machines.", "type": "boolean" } } }, "ListVmwareClustersResponse": { "id": "ListVmwareClustersResponse", "description": "Response message for listing VMware Clusters.", "type": "object", "properties": { "vmwareClusters": { "description": "The list of VMware Cluster.", "type": "array", "items": { "$ref": "VmwareCluster" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return. If the token is not empty this means that more results are available and should be retrieved by repeating the request with the provided page token.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } } }, "BareMetalDrainedMachine": { "description": "Represents a machine that is currently drained.", "type": "object", "id": "BareMetalDrainedMachine", "properties": { "nodeIp": { "description": "Drained machine IP address.", "type": "string" } } }, "VmwareAdminSeesawConfig": { "id": "VmwareAdminSeesawConfig", "description": "VmwareSeesawConfig represents configuration parameters for an already existing Seesaw load balancer. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update Seesaw configurations it can only bind a pre-existing configuration to a new user cluster. IMPORTANT: When attempting to create a user cluster with a pre-existing Seesaw load balancer you will need to follow some preparation steps before calling the 'CreateVmwareCluster' API method. First you will need to create the user cluster's namespace via kubectl. The namespace will need to use the following naming convention : -gke-onprem-mgmt or -gke-onprem-mgmt depending on whether you used the 'VmwareCluster.local_name' to disambiguate collisions; for more context see the documentation of 'VmwareCluster.local_name'. Once the namespace is created you will need to create a secret resource via kubectl. This secret will contain copies of your Seesaw credentials. The Secret must be called 'user-cluster-creds' and contain Seesaw's SSH and Cert credentials. The credentials must be keyed with the following names: 'seesaw-ssh-private-key', 'seesaw-ssh-public-key', 'seesaw-ssh-ca-key', 'seesaw-ssh-ca-cert'.", "type": "object", "properties": { "stackdriverName": { "description": "Name to be used by Stackdriver.", "type": "string" }, "enableHa": { "description": "Enable two load balancer VMs to achieve a highly-available Seesaw load balancer.", "type": "boolean" }, "ipBlocks": { "items": { "$ref": "VmwareIpBlock" }, "description": "The IP Blocks to be used by the Seesaw load balancer", "type": "array" }, "vms": { "description": "Names of the VMs created for this Seesaw group.", "type": "array", "items": { "type": "string" } }, "group": { "description": "In general the following format should be used for the Seesaw group name: seesaw-for-[cluster_name].", "type": "string" }, "masterIp": { "description": "MasterIP is the IP announced by the master of Seesaw group.", "type": "string" } } }, "BareMetalPortConfig": { "description": "Specifies load balancer ports for the bare metal user cluster.", "type": "object", "id": "BareMetalPortConfig", "properties": { "controlPlaneLoadBalancerPort": { "description": "The port that control plane hosted load balancers will listen on.", "type": "integer", "format": "int32" } } }, "BareMetalLvpShareConfig": { "properties": { "lvpConfig": { "description": "Required. Defines the machine path and storage class for the LVP Share.", "$ref": "BareMetalLvpConfig" }, "sharedPathPvCount": { "description": "The number of subdirectories to create under path.", "type": "integer", "format": "int32" } }, "id": "BareMetalLvpShareConfig", "description": "Specifies the configs for local persistent volumes under a shared file system.", "type": "object" }, "ListBareMetalNodePoolsResponse": { "description": "Response message for listing bare metal node pools.", "type": "object", "id": "ListBareMetalNodePoolsResponse", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "bareMetalNodePools": { "description": "The node pools from the specified parent resource.", "type": "array", "items": { "$ref": "BareMetalNodePool" } } } }, "OperationProgress": { "properties": { "stages": { "items": { "$ref": "OperationStage" }, "description": "The stages of the operation.", "type": "array" } }, "id": "OperationProgress", "description": "Information about operation progress.", "type": "object" }, "BareMetalAdminLoadBalancerAddressPool": { "description": "Represents an IP pool used by the load balancer.", "type": "object", "id": "BareMetalAdminLoadBalancerAddressPool", "properties": { "pool": { "description": "Required. The name of the address pool.", "type": "string" }, "addresses": { "items": { "type": "string" }, "description": "Required. The addresses that are part of this pool. Each address must be either in the CIDR form (1.2.3.0/24) or range form (1.2.3.1-1.2.3.5).", "type": "array" }, "avoidBuggyIps": { "description": "If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.", "type": "boolean" }, "manualAssign": { "description": "If true, prevent IP addresses from being automatically assigned.", "type": "boolean" } } }, "VmwareNodePool": { "description": "Resource VmwareNodePool represents a VMware node pool. ##", "type": "object", "id": "VmwareNodePool", "properties": { "name": { "description": "Immutable. The resource name of this node pool.", "type": "string" }, "config": { "$ref": "VmwareNodeConfig", "description": "Required. The node configuration of the node pool." }, "deleteTime": { "description": "Output only. The time at which this node pool was deleted. If the resource is not deleted, this must be empty", "type": "string", "readOnly": true, "format": "google-datetime" }, "status": { "$ref": "ResourceStatus", "readOnly": true, "description": "Output only. ResourceStatus representing the detailed VMware node pool state." }, "reconciling": { "description": "Output only. If set, there are currently changes in flight to the node pool.", "type": "boolean", "readOnly": true }, "uid": { "readOnly": true, "description": "Output only. The unique identifier of the node pool.", "type": "string" }, "displayName": { "description": "The display name for the node pool.", "type": "string" }, "nodePoolAutoscaling": { "description": "Node pool autoscaling config for the node pool.", "$ref": "VmwareNodePoolAutoscalingConfig" }, "state": { "readOnly": true, "enumDescriptions": [ "Not set.", "The PROVISIONING state indicates the node pool is being created.", "The RUNNING state indicates the node pool has been created and is fully usable.", "The RECONCILING state indicates that the node pool is being updated. It remains available, but potentially with degraded performance.", "The STOPPING state indicates the cluster is being deleted", "The ERROR state indicates the node pool is in a broken unrecoverable state.", "The DEGRADED state indicates the node pool requires user action to restore full functionality." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "RUNNING", "RECONCILING", "STOPPING", "ERROR", "DEGRADED" ], "description": "Output only. The current state of the node pool.", "type": "string" }, "annotations": { "description": "Annotations on the node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.", "type": "object", "additionalProperties": { "type": "string" } }, "updateTime": { "description": "Output only. The time at which this node pool was last updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "etag": { "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.", "type": "string" }, "onPremVersion": { "description": "Anthos version for the node pool. Defaults to the user cluster version.", "type": "string" }, "createTime": { "description": "Output only. The time at which this node pool was created.", "type": "string", "readOnly": true, "format": "google-datetime" } } }, "VmwareAdminHAControlPlaneConfig": { "properties": { "controlPlaneIpBlock": { "$ref": "VmwareIpBlock", "description": "Static IP addresses for the admin control plane nodes." } }, "description": "Specifies HA admin control plane config.", "type": "object", "id": "VmwareAdminHAControlPlaneConfig" }, "VmwareAutoResizeConfig": { "id": "VmwareAutoResizeConfig", "description": "Represents auto resizing configurations for the VMware user cluster.", "type": "object", "properties": { "enabled": { "description": "Whether to enable controle plane node auto resizing.", "type": "boolean" } } }, "VmwareAdminPrivateRegistryConfig": { "id": "VmwareAdminPrivateRegistryConfig", "description": "VmwareAdminPrivateRegistryConfig represents configuration for admin cluster registry.", "type": "object", "properties": { "address": { "description": "The registry address.", "type": "string" }, "caCert": { "description": "When the container runtime pulls an image from private registry, the registry must prove its identity by presenting a certificate. The registry's certificate is signed by a certificate authority (CA). The container runtime uses the CA's certificate to validate the registry's certificate.", "type": "string" } } }, "BareMetalNetworkConfig": { "description": "Specifies the cluster network configuration.", "type": "object", "id": "BareMetalNetworkConfig", "properties": { "srIovConfig": { "$ref": "BareMetalSrIovConfig", "description": "Configuration for SR-IOV." }, "islandModeCidr": { "$ref": "BareMetalIslandModeCidrConfig", "description": "Configuration for island mode CIDR. In an island-mode network, nodes have unique IP addresses, but pods don't have unique addresses across clusters. This doesn't cause problems because pods in one cluster never directly communicate with pods in another cluster. Instead, there are gateways that mediate between a pod in one cluster and a pod in another cluster." }, "advancedNetworking": { "description": "Enables the use of advanced Anthos networking features, such as Bundled Load Balancing with BGP or the egress NAT gateway. Setting configuration for advanced networking features will automatically set this flag.", "type": "boolean" }, "multipleNetworkInterfacesConfig": { "description": "Configuration for multiple network interfaces.", "$ref": "BareMetalMultipleNetworkInterfacesConfig" } } }, "BareMetalBgpPeerConfig": { "description": "BareMetalBgpPeerConfig represents configuration parameters for a Border Gateway Protocol (BGP) peer.", "type": "object", "id": "BareMetalBgpPeerConfig", "properties": { "asn": { "description": "Required. BGP autonomous system number (ASN) for the network that contains the external peer device.", "type": "string", "format": "int64" }, "ipAddress": { "description": "Required. The IP address of the external peer device.", "type": "string" }, "controlPlaneNodes": { "items": { "type": "string" }, "description": "The IP address of the control plane node that connects to the external peer. If you don't specify any control plane nodes, all control plane nodes can connect to the external peer. If you specify one or more IP addresses, only the nodes specified participate in peering sessions.", "type": "array" } } }, "Policy": { "properties": { "version": { "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32" }, "bindings": { "items": { "$ref": "Binding" }, "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "type": "array" }, "etag": { "format": "byte", "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "type": "string" } }, "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "type": "object", "id": "Policy" }, "VmwareStaticIpConfig": { "properties": { "ipBlocks": { "items": { "$ref": "VmwareIpBlock" }, "description": "Represents the configuration values for static IP allocation to nodes.", "type": "array" } }, "description": "Represents the network configuration required for the VMware user clusters with Static IP configurations.", "type": "object", "id": "VmwareStaticIpConfig" }, "EnrollBareMetalNodePoolRequest": { "properties": { "bareMetalNodePoolId": { "description": "User provided OnePlatform identifier that is used as part of the resource name. (https://tools.ietf.org/html/rfc1123) format.", "type": "string" }, "validateOnly": { "description": "If set, only validate the request, but do not actually enroll the node pool.", "type": "boolean" } }, "id": "EnrollBareMetalNodePoolRequest", "description": "Message for enrolling an existing bare metal node pool to the GKE on-prem API.", "type": "object" }, "BareMetalAdminManualLbConfig": { "properties": { "enabled": { "description": "Whether manual load balancing is enabled.", "type": "boolean" } }, "id": "BareMetalAdminManualLbConfig", "description": "BareMetalAdminManualLbConfig represents configuration parameters for a manual load balancer.", "type": "object" }, "BareMetalAdminMultipleNetworkInterfacesConfig": { "properties": { "enabled": { "description": "Whether to enable multiple network interfaces for your pods. When set network_config.advanced_networking is automatically set to true.", "type": "boolean" } }, "description": "Specifies the multiple networking interfaces cluster configuration.", "type": "object", "id": "BareMetalAdminMultipleNetworkInterfacesConfig" }, "VmwareHostIp": { "properties": { "ip": { "description": "IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).", "type": "string" }, "hostname": { "description": "Hostname of the machine. VM's name will be used if this field is empty.", "type": "string" } }, "id": "VmwareHostIp", "description": "Represents VMware user cluster node's network configuration.", "type": "object" }, "BareMetalControlPlaneConfig": { "properties": { "controlPlaneNodePoolConfig": { "$ref": "BareMetalControlPlaneNodePoolConfig", "description": "Required. Configures the node pool running the control plane." }, "apiServerArgs": { "items": { "$ref": "BareMetalApiServerArgument" }, "description": "Customizes the default API server args. Only a subset of customized flags are supported. For the exact format, refer to the [API server documentation](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).", "type": "array" } }, "description": "Specifies the control plane configuration.", "type": "object", "id": "BareMetalControlPlaneConfig" }, "VmwareDhcpIpConfig": { "properties": { "enabled": { "description": "enabled is a flag to mark if DHCP IP allocation is used for VMware user clusters.", "type": "boolean" } }, "description": "Represents the network configuration required for the VMware user clusters with DHCP IP configurations.", "type": "object", "id": "VmwareDhcpIpConfig" }, "VmwareNodeConfig": { "description": "Parameters that describe the configuration of all nodes within a given node pool.", "type": "object", "id": "VmwareNodeConfig", "properties": { "imageType": { "description": "Required. The OS image to be used for each node in a node pool. Currently `cos`, `cos_cgv2`, `ubuntu`, `ubuntu_cgv2`, `ubuntu_containerd` and `windows` are supported.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "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/", "type": "object" }, "replicas": { "description": "The number of nodes in the node pool.", "type": "string", "format": "int64" }, "bootDiskSizeGb": { "description": "VMware disk size to be used during creation.", "type": "string", "format": "int64" }, "image": { "description": "The OS image name in vCenter, only valid when using Windows.", "type": "string" }, "enableLoadBalancer": { "description": "Allow node pool traffic to be load balanced. Only works for clusters with MetalLB load balancers.", "type": "boolean" }, "cpus": { "format": "int64", "description": "The number of CPUs for each node in the node pool.", "type": "string" }, "memoryMb": { "description": "The megabytes of memory for each node in the node pool.", "type": "string", "format": "int64" }, "taints": { "description": "The initial taints assigned to nodes of this node pool.", "type": "array", "items": { "$ref": "NodeTaint" } }, "vsphereConfig": { "$ref": "VmwareVsphereConfig", "description": "Specifies the vSphere config for node pool." } } }, "SetIamPolicyRequest": { "properties": { "policy": { "$ref": "Policy", "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." } }, "description": "Request message for `SetIamPolicy` method.", "type": "object", "id": "SetIamPolicyRequest" }, "ListVmwareNodePoolsResponse": { "id": "ListVmwareNodePoolsResponse", "description": "Response message for listing VMware node pools.", "type": "object", "properties": { "vmwareNodePools": { "items": { "$ref": "VmwareNodePool" }, "description": "The node pools from the specified parent resource.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } } }, "BareMetalAdminWorkloadNodeConfig": { "properties": { "maxPodsPerNode": { "format": "int64", "description": "The maximum number of pods a node can run. The size of the CIDR range assigned to the node will be derived from this parameter. By default 110 Pods are created per Node. Upper bound is 250 for both HA and non-HA admin cluster. Lower bound is 64 for non-HA admin cluster and 32 for HA admin cluster.", "type": "string" } }, "id": "BareMetalAdminWorkloadNodeConfig", "description": "BareMetalAdminWorkloadNodeConfig specifies the workload node configurations.", "type": "object" }, "ListOperationsResponse": { "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } }, "operations": { "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request.", "type": "array" } }, "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object" }, "Fleet": { "properties": { "membership": { "readOnly": true, "description": "Output only. The name of the managed fleet Membership resource associated to this cluster. Membership names are formatted as `projects//locations//memberships/`.", "type": "string" } }, "description": "Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ##", "type": "object", "id": "Fleet" }, "VmwareAdminNetworkConfig": { "description": "VmwareAdminNetworkConfig contains network configuration for VMware admin cluster.", "type": "object", "id": "VmwareAdminNetworkConfig", "properties": { "podAddressCidrBlocks": { "description": "Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.", "type": "array", "items": { "type": "string" } }, "vcenterNetwork": { "description": "vcenter_network specifies vCenter network name.", "type": "string" }, "hostConfig": { "$ref": "VmwareHostConfig", "description": "Represents common network settings irrespective of the host's IP address." }, "serviceAddressCidrBlocks": { "items": { "type": "string" }, "description": "Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.", "type": "array" }, "dhcpIpConfig": { "description": "Configuration settings for a DHCP IP configuration.", "$ref": "VmwareDhcpIpConfig" }, "staticIpConfig": { "description": "Configuration settings for a static IP configuration.", "$ref": "VmwareStaticIpConfig" }, "haControlPlaneConfig": { "description": "Configuration for HA admin cluster control plane.", "$ref": "VmwareAdminHAControlPlaneConfig" } } }, "BareMetalSecurityConfig": { "description": "Specifies the security related settings for the bare metal user cluster.", "type": "object", "id": "BareMetalSecurityConfig", "properties": { "authorization": { "$ref": "Authorization", "description": "Configures user access to the user cluster." } } }, "ResourceStatus": { "properties": { "versions": { "description": "Shows the mapping of a given version to the number of machines under this version.", "$ref": "Versions" }, "errorMessage": { "description": "Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention.", "type": "string" }, "conditions": { "items": { "$ref": "ResourceCondition" }, "description": "ResourceCondition provide a standard mechanism for higher-level status reporting from controller.", "type": "array" }, "version": { "description": "Reflect current version of the resource.", "type": "string" } }, "description": "ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED).", "type": "object", "id": "ResourceStatus" }, "BareMetalAdminOsEnvironmentConfig": { "description": "Specifies operating system operation settings for cluster provisioning.", "type": "object", "id": "BareMetalAdminOsEnvironmentConfig", "properties": { "packageRepoExcluded": { "description": "Whether the package repo should be added when initializing bare metal machines.", "type": "boolean" } } }, "VmwareAdminVCenterConfig": { "id": "VmwareAdminVCenterConfig", "description": "VmwareAdminVCenterConfig contains VCenter configuration for VMware admin cluster.", "type": "object", "properties": { "cluster": { "description": "The name of the vCenter cluster for the admin cluster.", "type": "string" }, "address": { "description": "The vCenter IP address.", "type": "string" }, "resourcePool": { "description": "The name of the vCenter resource pool for the admin cluster.", "type": "string" }, "folder": { "description": "The name of the vCenter folder for the admin cluster.", "type": "string" }, "dataDisk": { "description": "The name of the virtual machine disk (VMDK) for the admin cluster.", "type": "string" }, "storagePolicyName": { "description": "The name of the vCenter storage policy for the user cluster.", "type": "string" }, "datacenter": { "description": "The name of the vCenter datacenter for the admin cluster.", "type": "string" }, "caCertData": { "description": "Contains the vCenter CA certificate public key for SSL verification.", "type": "string" }, "datastore": { "description": "The name of the vCenter datastore for the admin cluster.", "type": "string" } } }, "VmwareClusterUpgradePolicy": { "properties": { "controlPlaneOnly": { "description": "Controls whether the upgrade applies to the control plane only.", "type": "boolean" } }, "description": "VmwareClusterUpgradePolicy defines the cluster upgrade policy.", "type": "object", "id": "VmwareClusterUpgradePolicy" }, "QueryVmwareVersionConfigResponse": { "id": "QueryVmwareVersionConfigResponse", "description": "Response message for querying VMware user cluster version config.", "type": "object", "properties": { "versions": { "items": { "$ref": "VmwareVersionInfo" }, "description": "List of available versions to install or to upgrade to.", "type": "array" } } }, "VmwareManualLbConfig": { "description": "Represents configuration parameters for an already existing manual load balancer. Given the nature of manual load balancers it is expected that said load balancer will be fully managed by users. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update ManualLB configurations it can only bind a pre-existing configuration to a new VMware user cluster.", "type": "object", "id": "VmwareManualLbConfig", "properties": { "konnectivityServerNodePort": { "description": "NodePort for konnectivity server service running as a sidecar in each kube-apiserver pod (ex. 30564).", "type": "integer", "format": "int32" }, "ingressHttpsNodePort": { "format": "int32", "description": "NodePort for ingress service's https. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 30139).", "type": "integer" }, "controlPlaneNodePort": { "format": "int32", "description": "NodePort for control plane service. The Kubernetes API server in the admin cluster is implemented as a Service of type NodePort (ex. 30968).", "type": "integer" }, "ingressHttpNodePort": { "description": "NodePort for ingress service's http. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 32527).", "type": "integer", "format": "int32" } } }, "VmwareAutoRepairConfig": { "properties": { "enabled": { "description": "Whether auto repair is enabled.", "type": "boolean" } }, "description": "Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true.", "type": "object", "id": "VmwareAutoRepairConfig" }, "VmwareControlPlaneVsphereConfig": { "id": "VmwareControlPlaneVsphereConfig", "description": "Specifies control plane node config.", "type": "object", "properties": { "datastore": { "description": "The Vsphere datastore used by the control plane Node.", "type": "string" }, "storagePolicyName": { "description": "The Vsphere storage policy used by the control plane Node.", "type": "string" } } }, "UpgradeDependency": { "properties": { "currentVersion": { "description": "Current version of the dependency e.g. 1.15.0.", "type": "string" }, "membership": { "description": "Membership names are formatted as `projects//locations//memberships/`.", "type": "string" }, "targetVersion": { "description": "Target version of the dependency e.g. 1.16.1. This is the version the dependency needs to be upgraded to before a resource can be upgraded.", "type": "string" }, "resourceName": { "description": "Resource name of the dependency.", "type": "string" } }, "id": "UpgradeDependency", "description": "UpgradeDependency represents a dependency when upgrading a resource.", "type": "object" }, "EnrollVmwareNodePoolRequest": { "properties": { "vmwareNodePoolId": { "description": "The target node pool id to be enrolled.", "type": "string" } }, "description": "Message for enrolling a VMware node pool.", "type": "object", "id": "EnrollVmwareNodePoolRequest" }, "CancelOperationRequest": { "properties": {}, "description": "The request message for Operations.CancelOperation.", "type": "object", "id": "CancelOperationRequest" }, "BareMetalAdminNetworkConfig": { "id": "BareMetalAdminNetworkConfig", "description": "BareMetalAdminNetworkConfig specifies the cluster network configuration.", "type": "object", "properties": { "multipleNetworkInterfacesConfig": { "description": "Configuration for multiple network interfaces.", "$ref": "BareMetalAdminMultipleNetworkInterfacesConfig" }, "islandModeCidr": { "$ref": "BareMetalAdminIslandModeCidrConfig", "description": "Configuration for Island mode CIDR." }, "advancedNetworking": { "description": "Enables the use of advanced Anthos networking features, such as Bundled Load Balancing with BGP or the egress NAT gateway. Setting configuration for advanced networking features will automatically set this flag.", "type": "boolean" } } }, "BareMetalNodeConfig": { "properties": { "nodeIp": { "description": "The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1", "type": "string" }, "labels": { "description": "The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }.", "type": "object", "additionalProperties": { "type": "string" } } }, "description": "BareMetalNodeConfig lists machine addresses to access Nodes.", "type": "object", "id": "BareMetalNodeConfig" }, "BinaryAuthorization": { "id": "BinaryAuthorization", "description": "Configuration for Binary Authorization.", "type": "object", "properties": { "evaluationMode": { "enumDescriptions": [ "Default value", "Disable BinaryAuthorization", "Enforce Kubernetes admission requests with BinaryAuthorization using the project's singleton policy." ], "description": "Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.", "type": "string", "enum": [ "EVALUATION_MODE_UNSPECIFIED", "DISABLED", "PROJECT_SINGLETON_POLICY_ENFORCE" ] } } }, "VmwareLoadBalancerConfig": { "properties": { "metalLbConfig": { "$ref": "VmwareMetalLbConfig", "description": "Configuration for MetalLB typed load balancers." }, "vipConfig": { "$ref": "VmwareVipConfig", "description": "The VIPs used by the load balancer." }, "seesawConfig": { "$ref": "VmwareSeesawConfig", "readOnly": true, "description": "Output only. Configuration for Seesaw typed load balancers." }, "manualLbConfig": { "description": "Manually configured load balancers.", "$ref": "VmwareManualLbConfig" }, "f5Config": { "description": "Configuration for F5 Big IP typed load balancers.", "$ref": "VmwareF5BigIpConfig" } }, "description": "Specifies the locad balancer config for the VMware user cluster.", "type": "object", "id": "VmwareLoadBalancerConfig" }, "Expr": { "properties": { "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" } }, "id": "Expr", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "type": "object" }, "BareMetalControlPlaneNodePoolConfig": { "description": "Specifies the control plane node pool configuration.", "type": "object", "id": "BareMetalControlPlaneNodePoolConfig", "properties": { "nodePoolConfig": { "$ref": "BareMetalNodePoolConfig", "description": "Required. The generic configuration for a node pool running the control plane." } } }, "BareMetalClusterUpgradePolicy": { "description": "BareMetalClusterUpgradePolicy defines the cluster upgrade policy.", "type": "object", "id": "BareMetalClusterUpgradePolicy", "properties": { "pause": { "readOnly": true, "description": "Output only. Pause is used to show the upgrade pause status. It's view only for now.", "type": "boolean" }, "policy": { "description": "Specifies which upgrade policy to use.", "type": "string", "enumDescriptions": [ "No upgrade policy selected.", "Upgrade worker node pools sequentially.", "Upgrade all worker node pools in parallel." ], "enum": [ "NODE_POOL_POLICY_UNSPECIFIED", "SERIAL", "CONCURRENT" ] } } }, "BareMetalNodePool": { "description": "Resource that represents a bare metal node pool.", "type": "object", "id": "BareMetalNodePool", "properties": { "annotations": { "description": "Annotations on the bare metal node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.", "type": "object", "additionalProperties": { "type": "string" } }, "state": { "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "RUNNING", "RECONCILING", "STOPPING", "ERROR", "DEGRADED" ], "readOnly": true, "enumDescriptions": [ "Not set.", "The PROVISIONING state indicates the bare metal node pool is being created.", "The RUNNING state indicates the bare metal node pool has been created and is fully usable.", "The RECONCILING state indicates that the bare metal node pool is being updated. It remains available, but potentially with degraded performance.", "The STOPPING state indicates the bare metal node pool is being deleted.", "The ERROR state indicates the bare metal node pool is in a broken unrecoverable state.", "The DEGRADED state indicates the bare metal node pool requires user action to restore full functionality." ], "description": "Output only. The current state of the bare metal node pool.", "type": "string" }, "upgradePolicy": { "description": "The worker node pool upgrade policy.", "$ref": "BareMetalNodePoolUpgradePolicy" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this bare metal node pool was created.", "type": "string" }, "etag": { "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.", "type": "string" }, "nodePoolConfig": { "description": "Required. Node pool configuration.", "$ref": "BareMetalNodePoolConfig" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this bare metal node pool was last updated.", "type": "string" }, "reconciling": { "readOnly": true, "description": "Output only. If set, there are currently changes in flight to the bare metal node pool.", "type": "boolean" }, "status": { "readOnly": true, "description": "Output only. ResourceStatus representing the detailed node pool status.", "$ref": "ResourceStatus" }, "deleteTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this bare metal node pool was deleted. If the resource is not deleted, this must be empty", "type": "string" }, "name": { "description": "Immutable. The bare metal node pool resource name.", "type": "string" }, "displayName": { "description": "The display name for the bare metal node pool.", "type": "string" }, "uid": { "description": "Output only. The unique identifier of the bare metal node pool.", "type": "string", "readOnly": true } } }, "BareMetalAdminMachineDrainStatus": { "properties": { "drainedMachines": { "description": "The list of drained machines.", "type": "array", "items": { "$ref": "BareMetalAdminDrainedMachine" } }, "drainingMachines": { "items": { "$ref": "BareMetalAdminDrainingMachine" }, "description": "The list of draning machines.", "type": "array" } }, "description": "BareMetalAdminMachineDrainStatus represents the status of bare metal node machines that are undergoing drain operations.", "type": "object", "id": "BareMetalAdminMachineDrainStatus" }, "VmwareAdminAddonNodeConfig": { "properties": { "autoResizeConfig": { "$ref": "VmwareAutoResizeConfig", "description": "VmwareAutoResizeConfig config specifies auto resize config." } }, "id": "VmwareAdminAddonNodeConfig", "description": "VmwareAdminAddonNodeConfig contains add-on node configurations for VMware admin cluster.", "type": "object" }, "BareMetalLoadBalancerConfig": { "id": "BareMetalLoadBalancerConfig", "description": "Specifies the load balancer configuration.", "type": "object", "properties": { "bgpLbConfig": { "description": "Configuration for BGP typed load balancers. When set network_config.advanced_networking is automatically set to true.", "$ref": "BareMetalBgpLbConfig" }, "metalLbConfig": { "$ref": "BareMetalMetalLbConfig", "description": "Configuration for MetalLB load balancers." }, "vipConfig": { "description": "The VIPs used by the load balancer.", "$ref": "BareMetalVipConfig" }, "portConfig": { "description": "Configures the ports that the load balancer will listen on.", "$ref": "BareMetalPortConfig" }, "manualLbConfig": { "description": "Manually configured load balancers.", "$ref": "BareMetalManualLbConfig" } } }, "VmwareIpBlock": { "properties": { "gateway": { "description": "The network gateway used by the VMware user cluster.", "type": "string" }, "ips": { "items": { "$ref": "VmwareHostIp" }, "description": "The node's network configurations used by the VMware user cluster.", "type": "array" }, "netmask": { "description": "The netmask used by the VMware user cluster.", "type": "string" } }, "description": "Represents a collection of IP addresses to assign to nodes.", "type": "object", "id": "VmwareIpBlock" }, "BareMetalAdminVipConfig": { "properties": { "controlPlaneVip": { "description": "The VIP which you previously set aside for the Kubernetes API of this bare metal admin cluster.", "type": "string" } }, "id": "BareMetalAdminVipConfig", "description": "BareMetalAdminVipConfig for bare metal load balancer configurations.", "type": "object" }, "BareMetalAdminStorageConfig": { "id": "BareMetalAdminStorageConfig", "description": "BareMetalAdminStorageConfig specifies the cluster storage configuration.", "type": "object", "properties": { "lvpShareConfig": { "description": "Required. Specifies the config for local PersistentVolumes backed by subdirectories in a shared filesystem. These subdirectores are automatically created during cluster creation.", "$ref": "BareMetalLvpShareConfig" }, "lvpNodeMountsConfig": { "description": "Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation.", "$ref": "BareMetalLvpConfig" } } }, "BareMetalProxyConfig": { "properties": { "uri": { "description": "Required. Specifies the address of your proxy server. Examples: `http://domain` Do not provide credentials in the format `http://(username:password@)domain` these will be rejected by the server.", "type": "string" }, "noProxy": { "items": { "type": "string" }, "description": "A list of IPs, hostnames, and domains that should skip the proxy. Examples: [\"127.0.0.1\", \"example.com\", \".corp\", \"localhost\"].", "type": "array" } }, "id": "BareMetalProxyConfig", "description": "Specifies the cluster proxy configuration.", "type": "object" }, "QueryBareMetalVersionConfigResponse": { "description": "Response message for querying bare metal admin cluster version config.", "type": "object", "id": "QueryBareMetalVersionConfigResponse", "properties": { "versions": { "items": { "$ref": "BareMetalVersionInfo" }, "description": "List of available versions to install or to upgrade to.", "type": "array" } } }, "BareMetalAdminBgpLbConfig": { "id": "BareMetalAdminBgpLbConfig", "description": "BareMetalAdminBgpLbConfig represents configuration parameters for a Border Gateway Protocol (BGP) load balancer.", "type": "object", "properties": { "addressPools": { "items": { "$ref": "BareMetalAdminLoadBalancerAddressPool" }, "description": "Required. AddressPools is a list of non-overlapping IP pools used by load balancer typed services. All addresses must be routable to load balancer nodes. IngressVIP must be included in the pools.", "type": "array" }, "asn": { "format": "int64", "description": "Required. BGP autonomous system number (ASN) of the cluster. This field can be updated after cluster creation.", "type": "string" }, "bgpPeerConfigs": { "items": { "$ref": "BareMetalAdminBgpPeerConfig" }, "description": "Required. The list of BGP peers that the cluster will connect to. At least one peer must be configured for each control plane node. Control plane nodes will connect to these peers to advertise the control plane VIP. The Services load balancer also uses these peers by default. This field can be updated after cluster creation.", "type": "array" }, "loadBalancerNodePoolConfig": { "$ref": "BareMetalAdminLoadBalancerNodePoolConfig", "description": "Specifies the node pool running data plane load balancing. L2 connectivity is required among nodes in this pool. If missing, the control plane node pool is used for data plane load balancing." } } }, "BareMetalAdminCluster": { "description": "Resource that represents a bare metal admin cluster.", "type": "object", "id": "BareMetalAdminCluster", "properties": { "uid": { "readOnly": true, "description": "Output only. The unique identifier of the bare metal admin cluster.", "type": "string" }, "bareMetalVersion": { "description": "The Anthos clusters on bare metal version for the bare metal admin cluster.", "type": "string" }, "osEnvironmentConfig": { "description": "OS environment related configurations.", "$ref": "BareMetalAdminOsEnvironmentConfig" }, "binaryAuthorization": { "description": "Binary Authorization related configurations.", "$ref": "BinaryAuthorization" }, "controlPlane": { "$ref": "BareMetalAdminControlPlaneConfig", "description": "Control plane configuration." }, "maintenanceConfig": { "description": "Maintenance configuration.", "$ref": "BareMetalAdminMaintenanceConfig" }, "endpoint": { "description": "Output only. The IP address name of bare metal admin cluster's API server.", "type": "string", "readOnly": true }, "reconciling": { "readOnly": true, "description": "Output only. If set, there are currently changes in flight to the bare metal Admin Cluster.", "type": "boolean" }, "maintenanceStatus": { "$ref": "BareMetalAdminMaintenanceStatus", "description": "Output only. MaintenanceStatus representing state of maintenance.", "readOnly": true }, "clusterOperations": { "$ref": "BareMetalAdminClusterOperationsConfig", "description": "Cluster operations configuration." }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this bare metal admin cluster was created.", "type": "string" }, "proxy": { "$ref": "BareMetalAdminProxyConfig", "description": "Proxy configuration." }, "localName": { "description": "Output only. The object name of the bare metal cluster custom resource. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs.", "type": "string", "readOnly": true }, "annotations": { "description": "Annotations on the bare metal admin cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.", "type": "object", "additionalProperties": { "type": "string" } }, "validationCheck": { "$ref": "ValidationCheck", "readOnly": true, "description": "Output only. ValidationCheck representing the result of the preflight check." }, "nodeAccessConfig": { "description": "Node access related configurations.", "$ref": "BareMetalAdminNodeAccessConfig" }, "securityConfig": { "$ref": "BareMetalAdminSecurityConfig", "description": "Security related configuration." }, "name": { "description": "Immutable. The bare metal admin cluster resource name.", "type": "string" }, "deleteTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this bare metal admin cluster was deleted. If the resource is not deleted, this must be empty", "type": "string" }, "status": { "$ref": "ResourceStatus", "readOnly": true, "description": "Output only. ResourceStatus representing detailed cluster status." }, "description": { "description": "A human readable description of this bare metal admin cluster.", "type": "string" }, "loadBalancer": { "$ref": "BareMetalAdminLoadBalancerConfig", "description": "Load balancer configuration." }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this bare metal admin cluster was last updated.", "type": "string" }, "etag": { "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.", "type": "string" }, "networkConfig": { "$ref": "BareMetalAdminNetworkConfig", "description": "Network configuration." }, "storage": { "description": "Storage configuration.", "$ref": "BareMetalAdminStorageConfig" }, "nodeConfig": { "description": "Workload node configuration.", "$ref": "BareMetalAdminWorkloadNodeConfig" }, "state": { "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "RUNNING", "RECONCILING", "STOPPING", "ERROR", "DEGRADED" ], "readOnly": true, "enumDescriptions": [ "Not set.", "The PROVISIONING state indicates the cluster is being created.", "The RUNNING state indicates the cluster has been created and is fully usable.", "The RECONCILING state indicates that the cluster is being updated. It remains available, but potentially with degraded performance.", "The STOPPING state indicates the cluster is being deleted.", "The ERROR state indicates the cluster is in a broken unrecoverable state.", "The DEGRADED state indicates the cluster requires user action to restore full functionality." ], "description": "Output only. The current state of the bare metal admin cluster.", "type": "string" }, "fleet": { "readOnly": true, "description": "Output only. Fleet configuration for the cluster.", "$ref": "Fleet" } } }, "BareMetalManualLbConfig": { "properties": { "enabled": { "description": "Whether manual load balancing is enabled.", "type": "boolean" } }, "description": "Represents configuration parameters for a manual load balancer.", "type": "object", "id": "BareMetalManualLbConfig" }, "BareMetalBgpLbConfig": { "description": "BareMetalBgpLbConfig represents configuration parameters for a Border Gateway Protocol (BGP) load balancer.", "type": "object", "id": "BareMetalBgpLbConfig", "properties": { "asn": { "format": "int64", "description": "Required. BGP autonomous system number (ASN) of the cluster. This field can be updated after cluster creation.", "type": "string" }, "bgpPeerConfigs": { "description": "Required. The list of BGP peers that the cluster will connect to. At least one peer must be configured for each control plane node. Control plane nodes will connect to these peers to advertise the control plane VIP. The Services load balancer also uses these peers by default. This field can be updated after cluster creation.", "type": "array", "items": { "$ref": "BareMetalBgpPeerConfig" } }, "loadBalancerNodePoolConfig": { "description": "Specifies the node pool running data plane load balancing. L2 connectivity is required among nodes in this pool. If missing, the control plane node pool is used for data plane load balancing.", "$ref": "BareMetalLoadBalancerNodePoolConfig" }, "addressPools": { "description": "Required. AddressPools is a list of non-overlapping IP pools used by load balancer typed services. All addresses must be routable to load balancer nodes. IngressVIP must be included in the pools.", "type": "array", "items": { "$ref": "BareMetalLoadBalancerAddressPool" } } } }, "EnrollBareMetalAdminClusterRequest": { "properties": { "bareMetalAdminClusterId": { "description": "User provided OnePlatform identifier that is used as part of the resource name. This must be unique among all GKE on-prem clusters within a project and location and will return a 409 if the cluster already exists. (https://tools.ietf.org/html/rfc1123) format.", "type": "string" }, "membership": { "description": "Required. This is the full resource name of this admin cluster's fleet membership.", "type": "string" } }, "description": "Message for enrolling an existing bare metal admin cluster to the GKE on-prem API.", "type": "object", "id": "EnrollBareMetalAdminClusterRequest" }, "BareMetalMetalLbConfig": { "description": "Represents configuration parameters for a MetalLB load balancer.", "type": "object", "id": "BareMetalMetalLbConfig", "properties": { "addressPools": { "items": { "$ref": "BareMetalLoadBalancerAddressPool" }, "description": "Required. AddressPools is a list of non-overlapping IP pools used by load balancer typed services. All addresses must be routable to load balancer nodes. IngressVIP must be included in the pools.", "type": "array" }, "loadBalancerNodePoolConfig": { "$ref": "BareMetalLoadBalancerNodePoolConfig", "description": "Specifies the node pool running the load balancer. L2 connectivity is required among nodes in this pool. If missing, the control plane node pool is used as the load balancer pool." } } }, "BareMetalAdminClusterOperationsConfig": { "id": "BareMetalAdminClusterOperationsConfig", "description": "BareMetalAdminClusterOperationsConfig specifies the admin cluster's observability infrastructure.", "type": "object", "properties": { "enableApplicationLogs": { "description": "Whether collection of application logs/metrics should be enabled (in addition to system logs/metrics).", "type": "boolean" } } }, "BareMetalAdminBgpPeerConfig": { "id": "BareMetalAdminBgpPeerConfig", "description": "BareMetalAdminBgpPeerConfig represents configuration parameters for a Border Gateway Protocol (BGP) peer.", "type": "object", "properties": { "asn": { "format": "int64", "description": "Required. BGP autonomous system number (ASN) for the network that contains the external peer device.", "type": "string" }, "ipAddress": { "description": "Required. The IP address of the external peer device.", "type": "string" }, "controlPlaneNodes": { "description": "The IP address of the control plane node that connects to the external peer. If you don't specify any control plane nodes, all control plane nodes can connect to the external peer. If you specify one or more IP addresses, only the nodes specified participate in peering sessions.", "type": "array", "items": { "type": "string" } } } }, "VmwareAdminCluster": { "properties": { "state": { "description": "Output only. The current state of VMware admin cluster.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "RUNNING", "RECONCILING", "STOPPING", "ERROR", "DEGRADED" ], "readOnly": true, "enumDescriptions": [ "Not set.", "The PROVISIONING state indicates the cluster is being created.", "The RUNNING state indicates the cluster has been created and is fully usable.", "The RECONCILING state indicates that the cluster is being updated. It remains available, but potentially with degraded performance.", "The STOPPING state indicates the cluster is being deleted.", "The ERROR state indicates the cluster is in a broken unrecoverable state.", "The DEGRADED state indicates the cluster requires user action to restore full functionality." ] }, "fleet": { "$ref": "Fleet", "description": "Output only. Fleet configuration for the cluster.", "readOnly": true }, "controlPlaneNode": { "description": "The VMware admin cluster control plane node configuration.", "$ref": "VmwareAdminControlPlaneNodeConfig" }, "updateTime": { "description": "Output only. The time at which VMware admin cluster was last updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "etag": { "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.", "type": "string" }, "networkConfig": { "$ref": "VmwareAdminNetworkConfig", "description": "The VMware admin cluster network configuration." }, "name": { "description": "Immutable. The VMware admin cluster resource name.", "type": "string" }, "addonNode": { "$ref": "VmwareAdminAddonNodeConfig", "description": "The VMware admin cluster addon node configuration." }, "status": { "$ref": "ResourceStatus", "readOnly": true, "description": "Output only. ResourceStatus representing detailed cluster state." }, "description": { "description": "A human readable description of this VMware admin cluster.", "type": "string" }, "loadBalancer": { "description": "The VMware admin cluster load balancer configuration.", "$ref": "VmwareAdminLoadBalancerConfig" }, "imageType": { "description": "The OS image type for the VMware admin cluster.", "type": "string" }, "proxy": { "$ref": "VmwareAdminProxy", "description": "Configuration for proxy." }, "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations on the VMware admin cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.", "type": "object" }, "localName": { "readOnly": true, "description": "Output only. The object name of the VMware OnPremAdminCluster custom resource. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs.", "type": "string" }, "validationCheck": { "description": "Output only. ValidationCheck represents the result of the preflight check job.", "readOnly": true, "$ref": "ValidationCheck" }, "privateRegistryConfig": { "description": "Configuration for registry.", "$ref": "VmwareAdminPrivateRegistryConfig" }, "authorization": { "$ref": "VmwareAdminAuthorizationConfig", "description": "The VMware admin cluster authorization configuration." }, "enableAdvancedCluster": { "description": "Enable advanced cluster.", "type": "boolean" }, "onPremVersion": { "description": "The Anthos clusters on the VMware version for the admin cluster.", "type": "string" }, "autoRepairConfig": { "description": "The VMware admin cluster auto repair configuration.", "$ref": "VmwareAutoRepairConfig" }, "preparedSecrets": { "$ref": "VmwareAdminPreparedSecretsConfig", "description": "Output only. The VMware admin cluster prepared secrets configuration. It should always be enabled by the Central API, instead of letting users set it.", "readOnly": true }, "vcenter": { "description": "The VMware admin cluster VCenter configuration.", "$ref": "VmwareAdminVCenterConfig" }, "antiAffinityGroups": { "description": "The VMware admin cluster anti affinity group configuration.", "$ref": "VmwareAAGConfig" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which VMware admin cluster was created.", "type": "string" }, "endpoint": { "description": "Output only. The DNS name of VMware admin cluster's API server.", "type": "string", "readOnly": true }, "bootstrapClusterMembership": { "description": "The bootstrap cluster this VMware admin cluster belongs to.", "type": "string" }, "reconciling": { "readOnly": true, "description": "Output only. If set, there are currently changes in flight to the VMware admin cluster.", "type": "boolean" }, "uid": { "readOnly": true, "description": "Output only. The unique identifier of the VMware admin cluster.", "type": "string" }, "platformConfig": { "description": "The VMware platform configuration.", "$ref": "VmwarePlatformConfig" } }, "id": "VmwareAdminCluster", "description": "Resource that represents a VMware admin cluster.", "type": "object" }, "BareMetalAdminLoadBalancerNodePoolConfig": { "id": "BareMetalAdminLoadBalancerNodePoolConfig", "description": "Specifies the load balancer's node pool configuration.", "type": "object", "properties": { "nodePoolConfig": { "description": "The generic configuration for a node pool running a load balancer.", "$ref": "BareMetalNodePoolConfig" } } }, "BareMetalCluster": { "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time when the bare metal user cluster was created.", "type": "string" }, "clusterOperations": { "description": "Cluster operations configuration.", "$ref": "BareMetalClusterOperationsConfig" }, "maintenanceStatus": { "$ref": "BareMetalMaintenanceStatus", "readOnly": true, "description": "Output only. Status of on-going maintenance tasks." }, "localName": { "description": "Output only. The object name of the bare metal user cluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the name in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. When the local name and cluster name differ, the local name is used in the admin cluster controller logs. You use the cluster name when accessing the cluster using bmctl and kubectl.", "type": "string", "readOnly": true }, "annotations": { "description": "Annotations on the bare metal user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.", "type": "object", "additionalProperties": { "type": "string" } }, "validationCheck": { "$ref": "ValidationCheck", "readOnly": true, "description": "Output only. The result of the preflight check." }, "proxy": { "$ref": "BareMetalProxyConfig", "description": "Proxy configuration." }, "upgradePolicy": { "description": "The cluster upgrade policy.", "$ref": "BareMetalClusterUpgradePolicy" }, "adminClusterName": { "readOnly": true, "description": "Output only. The resource name of the bare metal admin cluster managing this user cluster.", "type": "string" }, "osEnvironmentConfig": { "$ref": "BareMetalOsEnvironmentConfig", "description": "OS environment related configurations." }, "binaryAuthorization": { "description": "Binary Authorization related configurations.", "$ref": "BinaryAuthorization" }, "bareMetalVersion": { "description": "Required. The Anthos clusters on bare metal version for your user cluster.", "type": "string" }, "uid": { "description": "Output only. The unique identifier of the bare metal user cluster.", "type": "string", "readOnly": true }, "reconciling": { "readOnly": true, "description": "Output only. If set, there are currently changes in flight to the bare metal user cluster.", "type": "boolean" }, "endpoint": { "description": "Output only. The IP address of the bare metal user cluster's API server.", "type": "string", "readOnly": true }, "controlPlane": { "$ref": "BareMetalControlPlaneConfig", "description": "Required. Control plane configuration." }, "maintenanceConfig": { "$ref": "BareMetalMaintenanceConfig", "description": "Maintenance configuration." }, "storage": { "$ref": "BareMetalStorageConfig", "description": "Required. Storage configuration." }, "etag": { "readOnly": true, "description": "Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.", "type": "string" }, "networkConfig": { "$ref": "BareMetalNetworkConfig", "description": "Required. Network configuration." }, "updateTime": { "description": "Output only. The time when the bare metal user cluster was last updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "state": { "readOnly": true, "enumDescriptions": [ "Not set.", "The PROVISIONING state indicates the cluster is being created.", "The RUNNING state indicates the cluster has been created and is fully usable.", "The RECONCILING state indicates that the cluster is being updated. It remains available, but potentially with degraded performance.", "The STOPPING state indicates the cluster is being deleted.", "The ERROR state indicates the cluster is in a broken unrecoverable state.", "The DEGRADED state indicates the cluster requires user action to restore full functionality." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "RUNNING", "RECONCILING", "STOPPING", "ERROR", "DEGRADED" ], "description": "Output only. The current state of the bare metal user cluster.", "type": "string" }, "fleet": { "$ref": "Fleet", "readOnly": true, "description": "Output only. Fleet configuration for the cluster." }, "nodeConfig": { "description": "Workload node configuration.", "$ref": "BareMetalWorkloadNodeConfig" }, "localNamespace": { "readOnly": true, "description": "Output only. The namespace of the cluster.", "type": "string" }, "adminClusterMembership": { "description": "Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership.", "type": "string" }, "securityConfig": { "$ref": "BareMetalSecurityConfig", "description": "Security related setting configuration." }, "nodeAccessConfig": { "$ref": "BareMetalNodeAccessConfig", "description": "Node access related configurations." }, "description": { "description": "A human readable description of this bare metal user cluster.", "type": "string" }, "loadBalancer": { "$ref": "BareMetalLoadBalancerConfig", "description": "Required. Load balancer configuration." }, "deleteTime": { "description": "Output only. The time when the bare metal user cluster was deleted. If the resource is not deleted, this must be empty", "type": "string", "readOnly": true, "format": "google-datetime" }, "status": { "description": "Output only. Detailed cluster status.", "readOnly": true, "$ref": "ResourceStatus" }, "name": { "description": "Immutable. The bare metal user cluster resource name.", "type": "string" } }, "id": "BareMetalCluster", "description": "Resource that represents a bare metal user cluster.", "type": "object" }, "TestIamPermissionsResponse": { "properties": { "permissions": { "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "type": "array", "items": { "type": "string" } } }, "id": "TestIamPermissionsResponse", "description": "Response message for `TestIamPermissions` method.", "type": "object" }, "VmwareAdminMetalLbConfig": { "properties": { "enabled": { "description": "Whether MetalLB is enabled.", "type": "boolean" } }, "id": "VmwareAdminMetalLbConfig", "description": "VmwareAdminMetalLbConfig represents configuration parameters for a MetalLB load balancer. For admin clusters, currently no configurations is needed.", "type": "object" }, "VmwareMetalLbConfig": { "properties": { "addressPools": { "description": "Required. AddressPools is a list of non-overlapping IP pools used by load balancer typed services. All addresses must be routable to load balancer nodes. IngressVIP must be included in the pools.", "type": "array", "items": { "$ref": "VmwareAddressPool" } } }, "id": "VmwareMetalLbConfig", "description": "Represents configuration parameters for the MetalLB load balancer.", "type": "object" }, "BareMetalKubeletConfig": { "id": "BareMetalKubeletConfig", "description": "KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options).", "type": "object", "properties": { "registryPullQps": { "description": "The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.", "type": "integer", "format": "int32" }, "serializeImagePullsDisabled": { "description": "Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version \u003c 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.", "type": "boolean" }, "registryBurst": { "format": "int32", "description": "The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.", "type": "integer" } } }, "BareMetalAdminNodeAccessConfig": { "properties": { "loginUser": { "description": "Required. LoginUser is the user name used to access node machines. It defaults to \"root\" if not set.", "type": "string" } }, "description": "Specifies the node access related settings for the bare metal admin cluster.", "type": "object", "id": "BareMetalAdminNodeAccessConfig" }, "ValidationCheck": { "properties": { "status": { "$ref": "ValidationCheckStatus", "description": "Output only. The detailed validation check status.", "readOnly": true }, "scenario": { "readOnly": true, "enumDescriptions": [ "Default value. This value is unused.", "The validation check occurred during a create flow.", "The validation check occurred during an update flow." ], "enum": [ "SCENARIO_UNSPECIFIED", "CREATE", "UPDATE" ], "description": "Output only. The scenario when the preflight checks were run.", "type": "string" }, "option": { "description": "Options used for the validation check", "type": "string", "enumDescriptions": [ "Default value. Standard preflight validation check will be used.", "Prevent failed preflight checks from failing.", "Skip all preflight check validations." ], "enum": [ "OPTIONS_UNSPECIFIED", "SKIP_VALIDATION_CHECK_BLOCKING", "SKIP_VALIDATION_ALL" ] } }, "description": "ValidationCheck represents the result of preflight check.", "type": "object", "id": "ValidationCheck" }, "VmwareSeesawConfig": { "properties": { "enableHa": { "description": "Enable two load balancer VMs to achieve a highly-available Seesaw load balancer.", "type": "boolean" }, "ipBlocks": { "description": "Required. The IP Blocks to be used by the Seesaw load balancer", "type": "array", "items": { "$ref": "VmwareIpBlock" } }, "stackdriverName": { "description": "Name to be used by Stackdriver.", "type": "string" }, "group": { "description": "Required. In general the following format should be used for the Seesaw group name: seesaw-for-[cluster_name].", "type": "string" }, "masterIp": { "description": "Required. MasterIP is the IP announced by the master of Seesaw group.", "type": "string" }, "vms": { "items": { "type": "string" }, "description": "Names of the VMs created for this Seesaw group.", "type": "array" } }, "id": "VmwareSeesawConfig", "description": "VmwareSeesawConfig represents configuration parameters for an already existing Seesaw load balancer. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update Seesaw configurations it can only bind a pre-existing configuration to a new user cluster. IMPORTANT: When attempting to create a user cluster with a pre-existing Seesaw load balancer you will need to follow some preparation steps before calling the 'CreateVmwareCluster' API method. First you will need to create the user cluster's namespace via kubectl. The namespace will need to use the following naming convention : -gke-onprem-mgmt or -gke-onprem-mgmt depending on whether you used the 'VmwareCluster.local_name' to disambiguate collisions; for more context see the documentation of 'VmwareCluster.local_name'. Once the namespace is created you will need to create a secret resource via kubectl. This secret will contain copies of your Seesaw credentials. The Secret must be called 'user-cluster-creds' and contain Seesaw's SSH and Cert credentials. The credentials must be keyed with the following names: 'seesaw-ssh-private-key', 'seesaw-ssh-public-key', 'seesaw-ssh-ca-key', 'seesaw-ssh-ca-cert'.", "type": "object" }, "EnrollBareMetalClusterRequest": { "properties": { "localName": { "description": "Optional. The object name of the bare metal cluster custom resource on the associated admin cluster. This field is used to support conflicting resource names when enrolling existing clusters to the API. When not provided, this field will resolve to the bare_metal_cluster_id. Otherwise, it must match the object name of the bare metal cluster custom resource. It is not modifiable outside / beyond the enrollment operation.", "type": "string" }, "adminClusterMembership": { "description": "Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources.", "type": "string" }, "localNamespace": { "description": "Optional. The namespace of the cluster.", "type": "string" }, "bareMetalClusterId": { "description": "User provided OnePlatform identifier that is used as part of the resource name. This must be unique among all bare metal clusters within a project and location and will return a 409 if the cluster already exists. (https://tools.ietf.org/html/rfc1123) format.", "type": "string" } }, "id": "EnrollBareMetalClusterRequest", "description": "Message for enrolling an existing bare metal cluster to the Anthos On-Prem API.", "type": "object" }, "NodeTaint": { "description": "NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.", "type": "object", "id": "NodeTaint", "properties": { "key": { "description": "Key associated with the effect.", "type": "string" }, "value": { "description": "Value associated with the effect.", "type": "string" }, "effect": { "enum": [ "EFFECT_UNSPECIFIED", "NO_SCHEDULE", "PREFER_NO_SCHEDULE", "NO_EXECUTE" ], "description": "The taint effect.", "type": "string", "enumDescriptions": [ "Not set.", "Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler.", "Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler.", "Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController." ] } } }, "VmwareControlPlaneNodeConfig": { "id": "VmwareControlPlaneNodeConfig", "description": "Specifies control plane node config for the VMware user cluster.", "type": "object", "properties": { "vsphereConfig": { "description": "Vsphere-specific config.", "$ref": "VmwareControlPlaneVsphereConfig" }, "cpus": { "description": "The number of CPUs for each admin cluster node that serve as control planes for this VMware user cluster. (default: 4 CPUs)", "type": "string", "format": "int64" }, "memory": { "description": "The megabytes of memory for each admin cluster node that serves as a control plane for this VMware user cluster (default: 8192 MB memory).", "type": "string", "format": "int64" }, "replicas": { "description": "The number of control plane nodes for this VMware user cluster. (default: 1 replica).", "type": "string", "format": "int64" }, "autoResizeConfig": { "description": "AutoResizeConfig provides auto resizing configurations.", "$ref": "VmwareAutoResizeConfig" } } } }, "discoveryVersion": "v1", "revision": "20260506", "ownerName": "Google", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "canonicalName": "GKE On-Prem", "fullyEncodeReservedExpansion": true, "id": "gkeonprem:v1", "servicePath": "", "ownerDomain": "google.com", "kind": "discovery#restDescription", "version": "v1", "protocol": "rest", "mtlsRootUrl": "https://gkeonprem.mtls.googleapis.com/", "batchPath": "batch", "basePath": "", "version_module": true, "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.list", "httpMethod": "GET", "response": { "$ref": "ListLocationsResponse" }, "parameters": { "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string", "location": "query" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string", "location": "query" }, "extraLocationTypes": { "location": "query", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true, "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "location": "query", "format": "int32" }, "name": { "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "path": "v1/{+name}/locations", "flatPath": "v1/projects/{projectsId}/locations" }, "get": { "httpMethod": "GET", "id": "gkeonprem.projects.locations.get", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "response": { "$ref": "Location" } } }, "resources": { "operations": { "methods": { "delete": { "response": { "$ref": "Empty" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "location": "path", "required": true, "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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`.", "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.operations.delete", "httpMethod": "DELETE" }, "cancel": { "httpMethod": "POST", "request": { "$ref": "CancelOperationRequest" }, "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.operations.cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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`.", "path": "v1/{+name}:cancel", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "response": { "$ref": "Empty" } }, "list": { "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageSize": { "description": "The standard list page size.", "type": "integer", "location": "query", "format": "int32" }, "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "ListOperationsResponse" }, "httpMethod": "GET", "id": "gkeonprem.projects.locations.operations.list", "parameterOrder": [ "name" ] }, "get": { "response": { "$ref": "Operation" }, "parameters": { "name": { "location": "path", "required": true, "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.operations.get", "httpMethod": "GET" } } }, "vmwareClusters": { "methods": { "list": { "path": "v1/{+parent}/vmwareClusters", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters", "parameters": { "filter": { "location": "query", "description": "A resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned.", "type": "string" }, "pageSize": { "description": "Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "location": "query", "format": "int32" }, "parent": { "description": "Required. The parent of the project and location where the clusters are listed in. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true }, "allowMissing": { "description": "Optional. If true, return list of Vmware Clusters including the ones that only exists in RMS.", "type": "boolean", "location": "query" }, "view": { "enum": [ "CLUSTER_VIEW_UNSPECIFIED", "BASIC", "FULL" ], "enumDescriptions": [ "If the value is not set, the default `FULL` view is used.", "Includes basic information of a cluster resource including cluster resource name and admin cluster membership.", "Includes the complete configuration for VMware cluster resource. This is the default value for ListVmwareClustersRequest method." ], "location": "query", "description": "View for VMware clusters. When `BASIC` is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.", "type": "string" }, "pageToken": { "description": "A token identifying a page of results the server should return.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists VMware Clusters in a given project and location.", "response": { "$ref": "ListVmwareClustersResponse" }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "gkeonprem.projects.locations.vmwareClusters.list" }, "queryVersionConfig": { "response": { "$ref": "QueryVmwareVersionConfigResponse" }, "parameters": { "upgradeConfig.clusterName": { "location": "query", "description": "The user cluster resource name. This is the full resource name of the user cluster resource. Format: \"projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}\"", "type": "string" }, "parent": { "description": "Required. The parent of the project and location to query for version config. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true }, "createConfig.adminClusterMembership": { "description": "The admin cluster membership. This is the full resource name of the admin cluster's fleet membership. Format: \"projects/{project}/locations/{location}/memberships/{membership}\"", "type": "string", "location": "query" }, "createConfig.adminClusterName": { "location": "query", "description": "The admin cluster resource name. This is the full resource name of the admin cluster resource. Format: \"projects/{project}/locations/{location}/vmwareAdminClusters/{vmware_admin_cluster}\"", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Queries the VMware user cluster version config.", "path": "v1/{+parent}/vmwareClusters:queryVersionConfig", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters:queryVersionConfig", "parameterOrder": [ "parent" ], "id": "gkeonprem.projects.locations.vmwareClusters.queryVersionConfig", "httpMethod": "POST" }, "create": { "path": "v1/{+parent}/vmwareClusters", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters", "parameters": { "validateOnly": { "description": "Validate the request without actually doing any updates.", "type": "boolean", "location": "query" }, "allowPreflightFailure": { "description": "Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with \"cluster already exists\" error and hence a update cluster is required to fix the cluster.", "type": "boolean", "location": "query" }, "parent": { "description": "Required. The parent of the project and location where this cluster is created in. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true }, "skipValidations": { "location": "query", "description": "Optional. List of validations to skip during cluster creation.", "repeated": true, "type": "string" }, "vmwareClusterId": { "description": "User provided identifier that is used as part of the resource name; This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new VMware user cluster in a given project and location.", "response": { "$ref": "Operation" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "request": { "$ref": "VmwareCluster" }, "id": "gkeonprem.projects.locations.vmwareClusters.create" }, "patch": { "id": "gkeonprem.projects.locations.vmwareClusters.patch", "request": { "$ref": "VmwareCluster" }, "parameterOrder": [ "name" ], "httpMethod": "PATCH", "response": { "$ref": "Operation" }, "parameters": { "name": { "location": "path", "required": true, "description": "Immutable. The VMware user cluster resource name.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$", "type": "string" }, "updateMask": { "description": "Required. Field mask is used to specify the fields to be overwritten in the VMwareCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the VmwareCluster message will be updated. Empty fields will be ignored unless a field mask is used.", "type": "string", "location": "query", "format": "google-fieldmask" }, "validateOnly": { "description": "Validate the request without actually doing any updates.", "type": "boolean", "location": "query" }, "skipValidations": { "location": "query", "repeated": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single VMware cluster.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}" }, "getIamPolicy": { "httpMethod": "GET", "id": "gkeonprem.projects.locations.vmwareClusters.getIamPolicy", "parameterOrder": [ "resource" ], "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$", "type": "string", "location": "path", "required": true }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "location": "query", "format": "int32" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "path": "v1/{+resource}:getIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}:getIamPolicy", "response": { "$ref": "Policy" } }, "get": { "id": "gkeonprem.projects.locations.vmwareClusters.get", "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "VmwareCluster" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the VMware user cluster to be returned. Format: \"projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}\"", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$", "type": "string" }, "allowMissing": { "description": "Optional. If true, return Vmware Cluster including the one that only exists in RMS.", "type": "boolean", "location": "query" }, "view": { "enumDescriptions": [ "If the value is not set, the default `FULL` view is used.", "Includes basic information of a cluster resource including cluster resource name and admin cluster membership.", "Includes the complete configuration for VMware cluster resource. This is the default value for GetVmwareClusterRequest method." ], "enum": [ "CLUSTER_VIEW_UNSPECIFIED", "BASIC", "FULL" ], "location": "query", "description": "View for VMware user cluster. When `BASIC` is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single VMware Cluster." }, "setIamPolicy": { "response": { "$ref": "Policy" }, "path": "v1/{+resource}:setIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}:setIamPolicy", "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "parameterOrder": [ "resource" ], "request": { "$ref": "SetIamPolicyRequest" }, "id": "gkeonprem.projects.locations.vmwareClusters.setIamPolicy", "httpMethod": "POST" }, "delete": { "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.vmwareClusters.delete", "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}", "parameters": { "validateOnly": { "description": "Validate the request without actually doing any updates.", "type": "boolean", "location": "query" }, "force": { "description": "If set to true, any node pools from the cluster will also be deleted.", "type": "boolean", "location": "query" }, "ignoreErrors": { "location": "query", "description": "If set to true, the deletion of a VMware user cluster resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's cluster resource and the on-prem admin cluster that hosts your user cluster is disconnected / unreachable or deleted. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP user cluster but an existing on-prem user cluster.", "type": "boolean" }, "name": { "location": "path", "required": true, "description": "Required. Name of the VMware user cluster to be deleted. Format: \"projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}\"", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$", "type": "string" }, "allowMissing": { "description": "If set to true, and the VMware cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.", "type": "boolean", "location": "query" }, "etag": { "description": "The current etag of the VMware cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single VMware Cluster." }, "enroll": { "response": { "$ref": "Operation" }, "path": "v1/{+parent}/vmwareClusters:enroll", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters:enroll", "parameters": { "parent": { "description": "Required. The parent of the project and location where the cluster is Enrolled in. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "id": "gkeonprem.projects.locations.vmwareClusters.enroll", "parameterOrder": [ "parent" ], "request": { "$ref": "EnrollVmwareClusterRequest" }, "httpMethod": "POST" }, "unenroll": { "response": { "$ref": "Operation" }, "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the VMware user cluster to be unenrolled. Format: \"projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}\"", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$", "type": "string" }, "allowMissing": { "description": "If set to true, and the VMware cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.", "type": "boolean", "location": "query" }, "etag": { "location": "query", "description": "The current etag of the VMware Cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.", "type": "string" }, "validateOnly": { "description": "Validate the request without actually doing any updates.", "type": "boolean", "location": "query" }, "force": { "description": "This is required if the cluster has any associated node pools. When set, any child node pools will also be unenrolled.", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1/{+name}:unenroll", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}:unenroll", "id": "gkeonprem.projects.locations.vmwareClusters.unenroll", "parameterOrder": [ "name" ], "httpMethod": "DELETE" }, "testIamPermissions": { "response": { "$ref": "TestIamPermissionsResponse" }, "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1/{+resource}:testIamPermissions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "parameterOrder": [ "resource" ], "id": "gkeonprem.projects.locations.vmwareClusters.testIamPermissions", "httpMethod": "POST" } }, "resources": { "operations": { "methods": { "get": { "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/operations/{operationsId}", "response": { "$ref": "Operation" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.vmwareClusters.operations.get" }, "list": { "parameters": { "name": { "location": "path", "required": true, "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/operations", "response": { "$ref": "ListOperationsResponse" }, "httpMethod": "GET", "id": "gkeonprem.projects.locations.vmwareClusters.operations.list", "parameterOrder": [ "name" ] } } }, "vmwareNodePools": { "methods": { "delete": { "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.delete", "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the node pool to delete. Format: projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool}", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$", "type": "string" }, "allowMissing": { "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.", "type": "boolean" }, "etag": { "location": "query", "description": "The current etag of the VmwareNodePool. If an etag is provided and does not match the current etag of the node pool, deletion will be blocked and an ABORTED error will be returned.", "type": "string" }, "validateOnly": { "description": "If set, only validate the request, but do not actually delete the node pool.", "type": "boolean", "location": "query" }, "ignoreErrors": { "location": "query", "description": "If set to true, the deletion of a VMware node pool resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's node pool resource and you've already deleted the on-prem admin cluster that hosted your node pool. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP node pool but an existing on-prem node pool.", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single VMware node pool.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}" }, "unenroll": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.unenroll", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the node pool to unenroll. Format: projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool}", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$", "type": "string" }, "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.", "type": "boolean", "location": "query" }, "validateOnly": { "description": "If set, only validate the request, but do not actually unenroll the node pool.", "type": "boolean", "location": "query" }, "etag": { "location": "query", "description": "The current etag of the VMware node pool. If an etag is provided and does not match the current etag of node pool, deletion will be blocked and an ABORTED error will be returned.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Unenrolls a VMware node pool to Anthos On-Prem API", "path": "v1/{+name}:unenroll", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}:unenroll", "response": { "$ref": "Operation" } }, "testIamPermissions": { "httpMethod": "POST", "id": "gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "parameterOrder": [ "resource" ], "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1/{+resource}:testIamPermissions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}:testIamPermissions", "response": { "$ref": "TestIamPermissionsResponse" } }, "enroll": { "id": "gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.enroll", "request": { "$ref": "EnrollVmwareNodePoolRequest" }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "Operation" }, "parameters": { "parent": { "description": "Required. The parent resource where the node pool is enrolled in.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Enrolls a VMware node pool to Anthos On-Prem API", "path": "v1/{+parent}/vmwareNodePools:enroll", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools:enroll" }, "getIamPolicy": { "response": { "$ref": "Policy" }, "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$", "type": "string" }, "options.requestedPolicyVersion": { "location": "query", "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "path": "v1/{+resource}:getIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}:getIamPolicy", "parameterOrder": [ "resource" ], "id": "gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.getIamPolicy", "httpMethod": "GET" }, "get": { "response": { "$ref": "VmwareNodePool" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}", "parameters": { "name": { "description": "Required. The name of the node pool to retrieve. projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool}", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$", "type": "string", "location": "path", "required": true }, "view": { "enum": [ "NODE_POOL_VIEW_UNSPECIFIED", "BASIC", "FULL" ], "enumDescriptions": [ "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.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single VMware node pool.", "id": "gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.get", "parameterOrder": [ "name" ], "httpMethod": "GET" }, "setIamPolicy": { "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "path": "v1/{+resource}:setIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}:setIamPolicy", "response": { "$ref": "Policy" }, "httpMethod": "POST", "id": "gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "parameterOrder": [ "resource" ] }, "create": { "response": { "$ref": "Operation" }, "path": "v1/{+parent}/vmwareNodePools", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools", "parameters": { "vmwareNodePoolId": { "description": "The ID to use for the node pool, which will become the final component of the node pool's resource name. This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format. The value must not be permitted to be a UUID (or UUID-like: anything matching /^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$/i).", "type": "string", "location": "query" }, "parent": { "location": "path", "required": true, "description": "Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/vmwareClusters/{cluster}", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$", "type": "string" }, "validateOnly": { "description": "If set, only validate the request, but do not actually create the node pool.", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new VMware node pool in a given project, location and VMWare cluster.", "id": "gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.create", "parameterOrder": [ "parent" ], "request": { "$ref": "VmwareNodePool" }, "httpMethod": "POST" }, "patch": { "httpMethod": "PATCH", "request": { "$ref": "VmwareNodePool" }, "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.patch", "parameters": { "name": { "description": "Immutable. The resource name of this node pool.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$", "type": "string", "location": "path", "required": true }, "updateMask": { "description": "Required. Field mask is used to specify the fields to be overwritten in the VMwareNodePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the VMwareNodePool message will be updated. Empty fields will be ignored unless a field mask is used.", "type": "string", "location": "query", "format": "google-fieldmask" }, "validateOnly": { "location": "query", "description": "Validate the request without actually doing any updates.", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single VMware node pool.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}", "response": { "$ref": "Operation" } }, "list": { "id": "gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.list", "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "ListVmwareNodePoolsResponse" }, "path": "v1/{+parent}/vmwareNodePools", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools", "parameters": { "pageSize": { "description": "The maximum number of node pools to return. The service may return fewer than this value. If unspecified, at most 50 node pools will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "location": "query", "format": "int32" }, "parent": { "description": "Required. The parent, which owns this collection of node pools. Format: projects/{project}/locations/{location}/vmwareClusters/{vmwareCluster}", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$", "type": "string", "location": "path", "required": true }, "pageToken": { "description": "A page token, received from a previous `ListVmwareNodePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListVmwareNodePools` must match the call that provided the page token.", "type": "string", "location": "query" }, "view": { "enumDescriptions": [ "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." ], "enum": [ "NODE_POOL_VIEW_UNSPECIFIED", "BASIC", "FULL" ], "location": "query", "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" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists VMware node pools in a given project, location and VMWare cluster." } }, "resources": { "operations": { "methods": { "get": { "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}/operations/{operationsId}", "response": { "$ref": "Operation" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.operations.get" }, "list": { "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.operations.list", "httpMethod": "GET", "response": { "$ref": "ListOperationsResponse" }, "parameters": { "pageSize": { "description": "The standard list page size.", "type": "integer", "location": "query", "format": "int32" }, "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$", "type": "string", "location": "path", "required": true }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}/operations" } } } } } } }, "bareMetalClusters": { "methods": { "getIamPolicy": { "httpMethod": "GET", "parameterOrder": [ "resource" ], "id": "gkeonprem.projects.locations.bareMetalClusters.getIamPolicy", "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$", "type": "string" }, "options.requestedPolicyVersion": { "location": "query", "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "path": "v1/{+resource}:getIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}:getIamPolicy", "response": { "$ref": "Policy" } }, "get": { "response": { "$ref": "BareMetalCluster" }, "parameters": { "view": { "enum": [ "CLUSTER_VIEW_UNSPECIFIED", "BASIC", "FULL" ], "enumDescriptions": [ "If the value is not set, the default `FULL` view is used.", "Includes basic information of a cluster resource including cluster resource name and admin cluster membership.", "Includes the complete configuration for bare metal cluster resource. This is the default value for GetBareMetalClusterRequest method." ], "description": "View for bare metal user cluster. When `BASIC` is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.", "type": "string", "location": "query" }, "name": { "description": "Required. Name of the bare metal user cluster to get. Format: \"projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}\"", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$", "type": "string", "location": "path", "required": true }, "allowMissing": { "location": "query", "description": "Optional. If true, return BareMetal Cluster including the one that only exists in RMS.", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single bare metal Cluster.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}", "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.bareMetalClusters.get", "httpMethod": "GET" }, "setIamPolicy": { "httpMethod": "POST", "request": { "$ref": "SetIamPolicyRequest" }, "parameterOrder": [ "resource" ], "id": "gkeonprem.projects.locations.bareMetalClusters.setIamPolicy", "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "path": "v1/{+resource}:setIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}:setIamPolicy", "response": { "$ref": "Policy" } }, "delete": { "id": "gkeonprem.projects.locations.bareMetalClusters.delete", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}", "parameters": { "validateOnly": { "location": "query", "description": "Validate the request without actually doing any updates.", "type": "boolean" }, "force": { "description": "If set to true, any node pools from the cluster will also be deleted.", "type": "boolean", "location": "query" }, "ignoreErrors": { "description": "If set to true, the deletion of a bare metal user cluster resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's cluster resource and the on-prem admin cluster that hosts your user cluster is disconnected / unreachable or deleted. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP user cluster but an existing on-prem user cluster.", "type": "boolean", "location": "query" }, "name": { "description": "Required. Name of the bare metal user cluster to be deleted. Format: \"projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}\"", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$", "type": "string", "location": "path", "required": true }, "allowMissing": { "location": "query", "description": "If set to true, and the bare metal cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.", "type": "boolean" }, "etag": { "description": "The current etag of the bare metal Cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single bare metal Cluster." }, "unenroll": { "response": { "$ref": "Operation" }, "parameters": { "validateOnly": { "location": "query", "description": "Validate the request without actually doing any updates.", "type": "boolean" }, "force": { "location": "query", "description": "This is required if the cluster has any associated node pools. When set, any child node pools will also be unenrolled.", "type": "boolean" }, "name": { "description": "Required. Name of the bare metal user cluster to be unenrolled. Format: \"projects/{project}/locations/{location}/bareMetalClusters/{cluster}\"", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$", "type": "string", "location": "path", "required": true }, "allowMissing": { "location": "query", "description": "If set to true, and the bare metal cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.", "type": "boolean" }, "etag": { "location": "query", "description": "The current etag of the bare metal Cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1/{+name}:unenroll", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}:unenroll", "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.bareMetalClusters.unenroll", "httpMethod": "DELETE" }, "testIamPermissions": { "response": { "$ref": "TestIamPermissionsResponse" }, "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1/{+resource}:testIamPermissions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "parameterOrder": [ "resource" ], "id": "gkeonprem.projects.locations.bareMetalClusters.testIamPermissions", "httpMethod": "POST" }, "enroll": { "httpMethod": "POST", "id": "gkeonprem.projects.locations.bareMetalClusters.enroll", "parameterOrder": [ "parent" ], "request": { "$ref": "EnrollBareMetalClusterRequest" }, "path": "v1/{+parent}/bareMetalClusters:enroll", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters:enroll", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent of the project and location where the cluster is enrolled in. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "response": { "$ref": "Operation" } }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "gkeonprem.projects.locations.bareMetalClusters.list", "parameters": { "filter": { "location": "query", "description": "A resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned.", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer" }, "parent": { "location": "path", "required": true, "description": "Required. The parent of the project and location where the clusters are listed in. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "allowMissing": { "location": "query", "description": "Optional. If true, return list of BareMetal Clusters including the ones that only exists in RMS.", "type": "boolean" }, "view": { "description": "View for bare metal Clusters. When `BASIC` is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.", "type": "string", "location": "query", "enum": [ "CLUSTER_VIEW_UNSPECIFIED", "BASIC", "FULL" ], "enumDescriptions": [ "If the value is not set, the default `FULL` view is used.", "Includes basic information of a cluster resource including cluster resource name and admin cluster membership.", "Includes the complete configuration for bare metal cluster resource. This is the default value for ListBareMetalClustersRequest method." ] }, "pageToken": { "description": "A token identifying a page of results the server should return.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists bare metal clusters in a given project and location.", "path": "v1/{+parent}/bareMetalClusters", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters", "response": { "$ref": "ListBareMetalClustersResponse" } }, "queryVersionConfig": { "response": { "$ref": "QueryBareMetalVersionConfigResponse" }, "parameters": { "createConfig.adminClusterMembership": { "location": "query", "description": "The admin cluster membership. This is the full resource name of the admin cluster's fleet membership. Format: \"projects/{project}/locations/{location}/memberships/{membership}\"", "type": "string" }, "createConfig.adminClusterName": { "location": "query", "description": "The admin cluster resource name. This is the full resource name of the admin cluster resource. Format: \"projects/{project}/locations/{location}/bareMetalAdminClusters/{bare_metal_admin_cluster}\"", "type": "string" }, "parent": { "location": "path", "required": true, "description": "Required. The parent of the project and location to query for version config. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "upgradeConfig.clusterName": { "description": "The user cluster resource name. This is the full resource name of the user cluster resource. Format: \"projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}\"", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Queries the bare metal user cluster version config.", "path": "v1/{+parent}/bareMetalClusters:queryVersionConfig", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters:queryVersionConfig", "id": "gkeonprem.projects.locations.bareMetalClusters.queryVersionConfig", "parameterOrder": [ "parent" ], "httpMethod": "POST" }, "create": { "path": "v1/{+parent}/bareMetalClusters", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent of the project and location where the cluster is created in. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "validateOnly": { "location": "query", "description": "Validate the request without actually doing any updates.", "type": "boolean" }, "allowPreflightFailure": { "location": "query", "description": "Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with \"cluster already exists\" error and hence a update cluster is required to fix the cluster.", "type": "boolean" }, "bareMetalClusterId": { "location": "query", "description": "Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new bare metal cluster in a given project and location.", "response": { "$ref": "Operation" }, "httpMethod": "POST", "id": "gkeonprem.projects.locations.bareMetalClusters.create", "parameterOrder": [ "parent" ], "request": { "$ref": "BareMetalCluster" } }, "patch": { "httpMethod": "PATCH", "request": { "$ref": "BareMetalCluster" }, "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.bareMetalClusters.patch", "parameters": { "name": { "description": "Immutable. The bare metal user cluster resource name.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$", "type": "string", "location": "path", "required": true }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. Field mask is used to specify the fields to be overwritten in the BareMetalCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the BareMetalCluster message will be updated. Empty fields will be ignored unless a field mask is used.", "type": "string" }, "allowMissing": { "location": "query", "description": "If set to true, and the bare metal cluster is not found, the request will create a new bare metal cluster with the provided configuration. The user must have both create and update permission to call Update with allow_missing set to true.", "type": "boolean" }, "validateOnly": { "location": "query", "description": "Validate the request without actually doing any updates.", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single bare metal Cluster.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}", "response": { "$ref": "Operation" } } }, "resources": { "operations": { "methods": { "get": { "response": { "$ref": "Operation" }, "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/operations/{operationsId}", "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.bareMetalClusters.operations.get", "httpMethod": "GET" }, "list": { "httpMethod": "GET", "id": "gkeonprem.projects.locations.bareMetalClusters.operations.list", "parameterOrder": [ "name" ], "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/operations", "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$", "type": "string", "location": "path", "required": true }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "ListOperationsResponse" } } } }, "bareMetalNodePools": { "methods": { "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the node pool to delete. Format: projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool}", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$", "type": "string" }, "allowMissing": { "location": "query", "description": "If set to true, and the bare metal node pool is not found, the request will succeed but no action will be taken on the server and return a completed LRO.", "type": "boolean" }, "etag": { "description": "The current etag of the BareMetalNodePool. If an etag is provided and does not match the current etag of the node pool, deletion will be blocked and an ABORTED error will be returned.", "type": "string", "location": "query" }, "validateOnly": { "description": "If set, only validate the request, but do not actually delete the node pool.", "type": "boolean", "location": "query" }, "ignoreErrors": { "location": "query", "description": "If set to true, the deletion of a bare metal node pool resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's node pool resource and you've already deleted the on-prem admin cluster that hosted your node pool. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP node pool but an existing on-prem node pool.", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single bare metal node pool.", "response": { "$ref": "Operation" } }, "enroll": { "response": { "$ref": "Operation" }, "path": "v1/{+parent}/bareMetalNodePools:enroll", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools:enroll", "parameters": { "parent": { "description": "Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/bareMetalClusters/{cluster}", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "id": "gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.enroll", "parameterOrder": [ "parent" ], "request": { "$ref": "EnrollBareMetalNodePoolRequest" }, "httpMethod": "POST" }, "unenroll": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.unenroll", "path": "v1/{+name}:unenroll", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}:unenroll", "parameters": { "etag": { "description": "The current etag of the bare metal node pool. If an etag is provided and does not match the current etag of node pool, deletion will be blocked and an ABORTED error will be returned.", "type": "string", "location": "query" }, "name": { "location": "path", "required": true, "description": "Required. The name of the node pool to unenroll. Format: projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool}", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$", "type": "string" }, "allowMissing": { "description": "If set to true, and the bare metal node pool is not found, the request will succeed but no action will be taken on the server and return a completed LRO.", "type": "boolean", "location": "query" }, "validateOnly": { "location": "query", "description": "If set, only validate the request, but do not actually unenroll the node pool.", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Unenrolls a bare metal node pool from Anthos On-Prem API.", "response": { "$ref": "Operation" } }, "testIamPermissions": { "response": { "$ref": "TestIamPermissionsResponse" }, "path": "v1/{+resource}:testIamPermissions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}:testIamPermissions", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "id": "gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.testIamPermissions", "parameterOrder": [ "resource" ], "request": { "$ref": "TestIamPermissionsRequest" }, "httpMethod": "POST" }, "getIamPolicy": { "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$", "type": "string", "location": "path", "required": true }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "location": "query", "format": "int32" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "path": "v1/{+resource}:getIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}:getIamPolicy", "response": { "$ref": "Policy" }, "httpMethod": "GET", "parameterOrder": [ "resource" ], "id": "gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.getIamPolicy" }, "get": { "response": { "$ref": "BareMetalNodePool" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}", "parameters": { "view": { "enum": [ "NODE_POOL_VIEW_UNSPECIFIED", "BASIC", "FULL" ], "enumDescriptions": [ "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." ], "location": "query", "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.", "type": "string" }, "name": { "location": "path", "required": true, "description": "Required. The name of the node pool to retrieve. projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool}", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single bare metal node pool.", "id": "gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.get", "parameterOrder": [ "name" ], "httpMethod": "GET" }, "setIamPolicy": { "httpMethod": "POST", "request": { "$ref": "SetIamPolicyRequest" }, "parameterOrder": [ "resource" ], "id": "gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.setIamPolicy", "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "path": "v1/{+resource}:setIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}:setIamPolicy", "response": { "$ref": "Policy" } }, "create": { "id": "gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.create", "request": { "$ref": "BareMetalNodePool" }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "Operation" }, "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/bareMetalClusters/{cluster}", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$", "type": "string" }, "validateOnly": { "location": "query", "description": "If set, only validate the request, but do not actually create the node pool.", "type": "boolean" }, "bareMetalNodePoolId": { "description": "The ID to use for the node pool, which will become the final component of the node pool's resource name. This value must be up to 63 characters, and valid characters are /a-z-/. The value must not be permitted to be a UUID (or UUID-like: anything matching /^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$/i).", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new bare metal node pool in a given project, location and Bare Metal cluster.", "path": "v1/{+parent}/bareMetalNodePools", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools" }, "patch": { "parameterOrder": [ "name" ], "request": { "$ref": "BareMetalNodePool" }, "id": "gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.patch", "httpMethod": "PATCH", "response": { "$ref": "Operation" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}", "parameters": { "name": { "location": "path", "required": true, "description": "Immutable. The bare metal node pool resource name.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$", "type": "string" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. Field mask is used to specify the fields to be overwritten in the BareMetalNodePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the BareMetalNodePool message will be updated. Empty fields will be ignored unless a field mask is used.", "type": "string" }, "allowMissing": { "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", "location": "query" }, "validateOnly": { "location": "query", "description": "Validate the request without actually doing any updates.", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single bare metal node pool." }, "list": { "httpMethod": "GET", "id": "gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.list", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent, which owns this collection of node pools. Format: projects/{project}/locations/{location}/bareMetalClusters/{bareMetalCluster}", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$", "type": "string", "location": "path", "required": true }, "pageToken": { "location": "query", "description": "A page token, received from a previous `ListBareMetalNodePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBareMetalNodePools` must match the call that provided the page token.", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "The maximum number of node pools to return. The service may return fewer than this value. If unspecified, at most 50 node pools will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer" }, "view": { "location": "query", "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" ], "enumDescriptions": [ "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." ] } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists bare metal node pools in a given project, location and bare metal cluster.", "path": "v1/{+parent}/bareMetalNodePools", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools", "response": { "$ref": "ListBareMetalNodePoolsResponse" } } }, "resources": { "operations": { "methods": { "list": { "id": "gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.operations.list", "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "ListOperationsResponse" }, "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "name": { "location": "path", "required": true, "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$", "type": "string" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}/operations" }, "get": { "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.operations.get", "httpMethod": "GET", "response": { "$ref": "Operation" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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." } } } } } } }, "vmwareAdminClusters": { "methods": { "getIamPolicy": { "httpMethod": "GET", "id": "gkeonprem.projects.locations.vmwareAdminClusters.getIamPolicy", "parameterOrder": [ "resource" ], "path": "v1/{+resource}:getIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}:getIamPolicy", "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$", "type": "string" }, "options.requestedPolicyVersion": { "location": "query", "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "response": { "$ref": "Policy" } }, "get": { "response": { "$ref": "VmwareAdminCluster" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}", "parameters": { "view": { "enum": [ "CLUSTER_VIEW_UNSPECIFIED", "BASIC", "FULL" ], "enumDescriptions": [ "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", "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" }, "name": { "description": "Required. Name of the VMware admin cluster to be returned. Format: \"projects/{project}/locations/{location}/vmwareAdminClusters/{vmware_admin_cluster}\"", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$", "type": "string", "location": "path", "required": true }, "allowMissing": { "description": "Optional. If true, return Vmware Admin Cluster including the one that only exists in RMS.", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single VMware admin cluster.", "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.vmwareAdminClusters.get", "httpMethod": "GET" }, "setIamPolicy": { "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "path": "v1/{+resource}:setIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}:setIamPolicy", "response": { "$ref": "Policy" }, "httpMethod": "POST", "request": { "$ref": "SetIamPolicyRequest" }, "parameterOrder": [ "resource" ], "id": "gkeonprem.projects.locations.vmwareAdminClusters.setIamPolicy" }, "enroll": { "response": { "$ref": "Operation" }, "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent of the project and location where the cluster is enrolled in. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1/{+parent}/vmwareAdminClusters:enroll", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters:enroll", "request": { "$ref": "EnrollVmwareAdminClusterRequest" }, "parameterOrder": [ "parent" ], "id": "gkeonprem.projects.locations.vmwareAdminClusters.enroll", "httpMethod": "POST" }, "unenroll": { "path": "v1/{+name}:unenroll", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}:unenroll", "parameters": { "etag": { "description": "The current etag of the VMware admin cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.", "type": "string", "location": "query" }, "name": { "location": "path", "required": true, "description": "Required. Name of the VMware admin cluster to be unenrolled. Format: \"projects/{project}/locations/{location}/vmwareAdminClusters/{cluster}\"", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$", "type": "string" }, "allowMissing": { "location": "query", "description": "If set to true, and the VMware admin cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.", "type": "boolean" }, "ignoreErrors": { "location": "query", "description": "Optional. If set to true, the unenrollment of a vmware admin cluster resource will succeed even if errors occur during unenrollment. This parameter can be used when you want to unenroll admin cluster resource and the on-prem admin cluster is disconnected / unreachable. WARNING: Using this parameter when your admin cluster still exists may result in a deleted GCP admin cluster but existing resourcelink in on-prem admin cluster and membership.", "type": "boolean" }, "validateOnly": { "location": "query", "description": "Validate the request without actually doing any updates.", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "id": "gkeonprem.projects.locations.vmwareAdminClusters.unenroll", "parameterOrder": [ "name" ] }, "testIamPermissions": { "path": "v1/{+resource}:testIamPermissions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}:testIamPermissions", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "response": { "$ref": "TestIamPermissionsResponse" }, "httpMethod": "POST", "id": "gkeonprem.projects.locations.vmwareAdminClusters.testIamPermissions", "parameterOrder": [ "resource" ], "request": { "$ref": "TestIamPermissionsRequest" } }, "list": { "path": "v1/{+parent}/vmwareAdminClusters", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters", "parameters": { "pageToken": { "description": "A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "view": { "description": "View for VMware admin clusters. When `BASIC` is specified, only the admin cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete admin cluster configuration details.", "type": "string", "location": "query", "enum": [ "CLUSTER_VIEW_UNSPECIFIED", "BASIC", "FULL" ], "enumDescriptions": [ "If the value is not set, the default `FULL` view is used.", "Includes basic information of a admin cluster resource including admin cluster resource name and membership.", "Includes the complete configuration for bare metal admin cluster resource. This is the default value for ListVmwareAdminClustersRequest method." ] }, "pageSize": { "description": "Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "location": "query", "format": "int32" }, "parent": { "location": "path", "required": true, "description": "Required. The parent of the project and location where the clusters are listed in. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "allowMissing": { "location": "query", "description": "Optional. If true, return list of Vmware Admin Clusters including the ones that only exists in RMS.", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists VMware admin clusters in a given project and location.", "response": { "$ref": "ListVmwareAdminClustersResponse" }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "gkeonprem.projects.locations.vmwareAdminClusters.list" }, "create": { "parameterOrder": [ "parent" ], "request": { "$ref": "VmwareAdminCluster" }, "id": "gkeonprem.projects.locations.vmwareAdminClusters.create", "httpMethod": "POST", "response": { "$ref": "Operation" }, "path": "v1/{+parent}/vmwareAdminClusters", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters", "parameters": { "vmwareAdminClusterId": { "description": "Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent of the project and location where the cluster is created in. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true }, "skipValidations": { "description": "Optional. If set, skip the specified validations.", "repeated": true, "type": "string", "location": "query" }, "validateOnly": { "description": "Validate the request without actually doing any updates.", "type": "boolean", "location": "query" }, "allowPreflightFailure": { "location": "query", "description": "Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with \"cluster already exists\" error and hence a update cluster is required to fix the cluster.", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new VMware admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work." }, "patch": { "parameters": { "name": { "location": "path", "required": true, "description": "Immutable. The VMware admin cluster resource name.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$", "type": "string" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. Field mask is used to specify the fields to be overwritten in the VMwareAdminCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the VmwareAdminCluster message will be updated. Empty fields will be ignored unless a field mask is used.", "type": "string" }, "validateOnly": { "location": "query", "description": "Validate the request without actually doing any updates.", "type": "boolean" }, "skipValidations": { "location": "query", "description": "Optional. If set, the server-side preflight checks will be skipped.", "repeated": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single VMware admin cluster.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}", "response": { "$ref": "Operation" }, "httpMethod": "PATCH", "id": "gkeonprem.projects.locations.vmwareAdminClusters.patch", "request": { "$ref": "VmwareAdminCluster" }, "parameterOrder": [ "name" ] } }, "resources": { "operations": { "methods": { "list": { "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.vmwareAdminClusters.operations.list", "httpMethod": "GET", "response": { "$ref": "ListOperationsResponse" }, "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$", "type": "string", "location": "path", "required": true }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}/operations" }, "get": { "response": { "$ref": "Operation" }, "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}/operations/{operationsId}", "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.vmwareAdminClusters.operations.get", "httpMethod": "GET" } } } } }, "bareMetalAdminClusters": { "methods": { "list": { "response": { "$ref": "ListBareMetalAdminClustersResponse" }, "parameters": { "pageToken": { "location": "query", "description": "A token identifying a page of results the server should return.", "type": "string" }, "view": { "location": "query", "description": "View for bare metal admin clusters. When `BASIC` is specified, only the admin cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete admin cluster configuration details.", "type": "string", "enum": [ "CLUSTER_VIEW_UNSPECIFIED", "BASIC", "FULL" ], "enumDescriptions": [ "If the value is not set, the default `FULL` view is used.", "Includes basic information of a admin cluster resource including admin cluster resource name and membership.", "Includes the complete configuration for bare metal admin cluster resource. This is the default value for ListBareMetalAdminClustersRequest method." ] }, "parent": { "location": "path", "required": true, "description": "Required. The parent of the project and location where the clusters are listed in. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "allowMissing": { "description": "Optional. If true, return list of BareMetal Admin Clusters including the ones that only exists in RMS.", "type": "boolean", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "description": "Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists bare metal admin clusters in a given project and location.", "path": "v1/{+parent}/bareMetalAdminClusters", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters", "parameterOrder": [ "parent" ], "id": "gkeonprem.projects.locations.bareMetalAdminClusters.list", "httpMethod": "GET" }, "queryVersionConfig": { "id": "gkeonprem.projects.locations.bareMetalAdminClusters.queryVersionConfig", "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "QueryBareMetalAdminVersionConfigResponse" }, "parameters": { "parent": { "description": "Required. The parent of the project and location to query for version config. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true }, "upgradeConfig.clusterName": { "location": "query", "description": "The admin cluster resource name. This is the full resource name of the admin cluster resource. Format: \"projects/{project}/locations/{location}/bareMetalAdminClusters/{bare_metal_admin_cluster}\"", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Queries the bare metal admin cluster version config.", "path": "v1/{+parent}/bareMetalAdminClusters:queryVersionConfig", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters:queryVersionConfig" }, "patch": { "httpMethod": "PATCH", "id": "gkeonprem.projects.locations.bareMetalAdminClusters.patch", "request": { "$ref": "BareMetalAdminCluster" }, "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "description": "Immutable. The bare metal admin cluster resource name.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$", "type": "string" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. Field mask is used to specify the fields to be overwritten in the BareMetalAdminCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the BareMetalAdminCluster message will be updated. Empty fields will be ignored unless a field mask is used.", "type": "string" }, "validateOnly": { "description": "Validate the request without actually doing any updates.", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single bare metal admin cluster.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}", "response": { "$ref": "Operation" } }, "create": { "request": { "$ref": "BareMetalAdminCluster" }, "parameterOrder": [ "parent" ], "id": "gkeonprem.projects.locations.bareMetalAdminClusters.create", "httpMethod": "POST", "response": { "$ref": "Operation" }, "parameters": { "parent": { "description": "Required. The parent of the project and location where the cluster is created in. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true }, "validateOnly": { "location": "query", "description": "Validate the request without actually doing any updates.", "type": "boolean" }, "allowPreflightFailure": { "description": "Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with \"cluster already exists\" error and hence a update cluster is required to fix the cluster.", "type": "boolean", "location": "query" }, "bareMetalAdminClusterId": { "location": "query", "description": "Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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", "path": "v1/{+parent}/bareMetalAdminClusters", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters" }, "get": { "httpMethod": "GET", "id": "gkeonprem.projects.locations.bareMetalAdminClusters.get", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. Name of the bare metal admin cluster to get. Format: \"projects/{project}/locations/{location}/bareMetalAdminClusters/{bare_metal_admin_cluster}\"", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$", "type": "string", "location": "path", "required": true }, "allowMissing": { "description": "Optional. If true, return BareMetal Admin Cluster including the one that only exists in RMS.", "type": "boolean", "location": "query" }, "view": { "location": "query", "description": "View for bare metal 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", "enumDescriptions": [ "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 bare metal admin cluster resource. This is the default value for GetBareMetalAdminClusterRequest method." ], "enum": [ "CLUSTER_VIEW_UNSPECIFIED", "BASIC", "FULL" ] } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single bare metal admin cluster.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}", "response": { "$ref": "BareMetalAdminCluster" } }, "setIamPolicy": { "id": "gkeonprem.projects.locations.bareMetalAdminClusters.setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "parameterOrder": [ "resource" ], "httpMethod": "POST", "response": { "$ref": "Policy" }, "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "path": "v1/{+resource}:setIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}:setIamPolicy" }, "getIamPolicy": { "response": { "$ref": "Policy" }, "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$", "type": "string" }, "options.requestedPolicyVersion": { "location": "query", "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "path": "v1/{+resource}:getIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}:getIamPolicy", "parameterOrder": [ "resource" ], "id": "gkeonprem.projects.locations.bareMetalAdminClusters.getIamPolicy", "httpMethod": "GET" }, "unenroll": { "response": { "$ref": "Operation" }, "path": "v1/{+name}:unenroll", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}:unenroll", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the bare metal admin cluster to be unenrolled. Format: \"projects/{project}/locations/{location}/bareMetalAdminClusters/{cluster}\"", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$", "type": "string" }, "allowMissing": { "location": "query", "description": "If set to true, and the bare metal admin cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.", "type": "boolean" }, "etag": { "description": "The current etag of the bare metal admin cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.", "type": "string", "location": "query" }, "validateOnly": { "location": "query", "description": "Validate the request without actually doing any updates.", "type": "boolean" }, "ignoreErrors": { "description": "If set to true, the unenrollment of a bare metal admin cluster resource will succeed even if errors occur during unenrollment. This parameter can be used when you want to unenroll admin cluster resource and the on-prem admin cluster is disconnected / unreachable. WARNING: Using this parameter when your admin cluster still exists may result in a deleted GCP admin cluster but existing resourcelink in on-prem admin cluster and membership.", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "id": "gkeonprem.projects.locations.bareMetalAdminClusters.unenroll", "parameterOrder": [ "name" ], "httpMethod": "DELETE" }, "testIamPermissions": { "path": "v1/{+resource}:testIamPermissions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}:testIamPermissions", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "response": { "$ref": "TestIamPermissionsResponse" }, "httpMethod": "POST", "id": "gkeonprem.projects.locations.bareMetalAdminClusters.testIamPermissions", "parameterOrder": [ "resource" ], "request": { "$ref": "TestIamPermissionsRequest" } }, "enroll": { "parameters": { "parent": { "description": "Required. The parent of the project and location where the cluster is enrolled in. Format: \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1/{+parent}/bareMetalAdminClusters:enroll", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters:enroll", "response": { "$ref": "Operation" }, "httpMethod": "POST", "request": { "$ref": "EnrollBareMetalAdminClusterRequest" }, "parameterOrder": [ "parent" ], "id": "gkeonprem.projects.locations.bareMetalAdminClusters.enroll" } }, "resources": { "operations": { "methods": { "get": { "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}/operations/{operationsId}", "response": { "$ref": "Operation" }, "httpMethod": "GET", "id": "gkeonprem.projects.locations.bareMetalAdminClusters.operations.get", "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "gkeonprem.projects.locations.bareMetalAdminClusters.operations.list", "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalAdminClusters/[^/]+$", "type": "string", "location": "path", "required": true }, "pageSize": { "description": "The standard list page size.", "type": "integer", "location": "query", "format": "int32" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}/operations", "response": { "$ref": "ListOperationsResponse" } } } } } } } } } } }, "description": "", "parameters": { "quotaUser": { "type": "string", "description": "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.", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "alt": { "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "location": "query", "type": "string", "description": "Data format for response." }, "prettyPrint": { "default": "true", "location": "query", "type": "boolean", "description": "Returns response with indentations and line breaks." }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "description": "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.", "location": "query" }, "upload_protocol": { "location": "query", "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "$.xgafv": { "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string", "description": "V1 error format." } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "rootUrl": "https://gkeonprem.googleapis.com/", "name": "gkeonprem", "title": "GKE On-Prem API" }