View Source GoogleApi.GKEOnPrem.V1.Api.Projects (google_api_gke_on_prem v0.3.0)
API calls for all endpoints tagged Projects
.
Summary
Functions
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
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.
Gets details of a single bare metal admin cluster.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists bare metal admin clusters in a given project and location.
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.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Updates the parameters of a single bare metal admin cluster.
Queries the bare metal admin cluster version config.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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.
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.
Creates a new bare metal node pool in a given project, location and Bare Metal cluster.
Deletes a single bare metal node pool.
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.
Gets details of a single bare metal node pool.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists bare metal node pools in a given project, location and bare metal cluster.
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.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Updates the parameters of a single bare metal node pool.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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.
Unenrolls a bare metal node pool from Anthos On-Prem API.
Creates a new bare metal cluster in a given project and location.
Deletes a single bare metal Cluster.
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.
Gets details of a single bare metal Cluster.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists bare metal clusters in a given project and location.
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.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Updates the parameters of a single bare metal Cluster.
Queries the bare metal user cluster version config.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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.
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.
Gets information about a location.
Lists information about the supported locations for this service.
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
.
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
.
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.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
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.
Gets details of a single VMware admin cluster.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists VMware admin clusters in a given project and location.
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.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Updates the parameters of a single VMware admin cluster.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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.
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.
Creates a new VMware user cluster in a given project and location.
Deletes a single VMware Cluster.
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.
Gets details of a single VMware Cluster.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists VMware Clusters in a given project and location.
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.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Updates the parameters of a single VMware cluster.
Queries the VMware user cluster version config.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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.
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.
Creates a new VMware node pool in a given project, location and VMWare cluster.
Deletes a single VMware node pool.
Enrolls a VMware node pool to Anthos On-Prem API
Gets details of a single VMware node pool.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists VMware node pools in a given project, location and VMWare cluster.
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.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Updates the parameters of a single VMware node pool.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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.
Unenrolls a VMware node pool to Anthos On-Prem API
Functions
gkeonprem_projects_locations_bare_metal_admin_clusters_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_admin_clusters_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location where the cluster is created in. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:bareMetalAdminClusterId
(type:String.t
) - 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]$/ -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates. -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.BareMetalAdminCluster.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_admin_clusters_enroll(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_admin_clusters_enroll( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.EnrollBareMetalAdminClusterRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_admin_clusters_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_admin_clusters_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.BareMetalAdminCluster.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single bare metal admin cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the bare metal admin cluster to get. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{bare_metal_admin_cluster}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:view
(type:String.t
) - View for bare metal admin cluster. WhenBASIC
is specified, only the cluster resource name and membership are returned. The default/unset valueCLUSTER_VIEW_UNSPECIFIED
is the same asFULL', which returns the complete cluster configuration details. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
-
gkeonprem_projects_locations_bare_metal_admin_clusters_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_admin_clusters_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Policy{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_admin_clusters_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_admin_clusters_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListBareMetalAdminClustersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists bare metal admin clusters in a given project and location.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - A token identifying a page of results the server should return. -
:view
(type:String.t
) - View for bare metal admin clusters. WhenBASIC
is specified, only the admin cluster resource name and membership are returned. The default/unset valueCLUSTER_VIEW_UNSPECIFIED
is the same asFULL', which returns the complete admin cluster configuration details. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
-
gkeonprem_projects_locations_bare_metal_admin_clusters_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_admin_clusters_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_admin_clusters_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_admin_clusters_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_admin_clusters_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_admin_clusters_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the parameters of a single bare metal admin cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Immutable. The bare metal admin cluster resource name. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - 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. -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates. -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.BareMetalAdminCluster.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_admin_clusters_query_version_config(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_admin_clusters_query_version_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.QueryBareMetalAdminVersionConfigResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Queries the bare metal admin cluster version config.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location to query for version config. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"upgradeConfig.clusterName"
(type:String.t
) - 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}"
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.QueryBareMetalAdminVersionConfigResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_admin_clusters_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_admin_clusters_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Policy{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_admin_clusters_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_admin_clusters_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_admin_clusters_unenroll(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_admin_clusters_unenroll( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the bare metal admin cluster to be unenrolled. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{cluster}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - 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. -
:etag
(type:String.t
) - 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. -
:ignoreErrors
(type:boolean()
) - 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. -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new bare metal node pool in a given project, location and Bare Metal cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/bareMetalClusters/{cluster} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:bareMetalNodePoolId
(type:String.t
) - 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). -
:validateOnly
(type:boolean()
) - If set, only validate the request, but do not actually create the node pool. -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.BareMetalNodePool.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a single bare metal node pool.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the node pool to delete. Format: projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - 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. -
:etag
(type:String.t
) - 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. -
:ignoreErrors
(type:boolean()
) - 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. -
:validateOnly
(type:boolean()
) - If set, only validate the request, but do not actually delete the node pool.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_enroll(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_enroll( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/bareMetalClusters/{cluster} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.EnrollBareMetalNodePoolRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.BareMetalNodePool.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single bare metal node pool.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the node pool to retrieve. projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:view
(type:String.t
) - View for bare metal node pool. WhenBASIC
is specified, only the node pool resource name is returned. The default/unset valueNODE_POOL_VIEW_UNSPECIFIED
is the same asFULL', which returns the complete node pool configuration details. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
-
gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Policy{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListBareMetalNodePoolsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists bare metal node pools in a given project, location and bare metal cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent, which owns this collection of node pools. Format: projects/{project}/locations/{location}/bareMetalClusters/{bareMetalCluster} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - A page token, received from a previousListBareMetalNodePools
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListBareMetalNodePools
must match the call that provided the page token. -
:view
(type:String.t
) - View for bare metal node pools. WhenBASIC
is specified, only the node pool resource name is returned. The default/unset valueNODE_POOL_VIEW_UNSPECIFIED
is the same asFULL', which returns the complete node pool configuration details. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
-
gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the parameters of a single bare metal node pool.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Immutable. The bare metal node pool resource name. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - 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. -
:updateMask
(type:String.t
) - 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. -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates. -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.BareMetalNodePool.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Policy{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_unenroll(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_bare_metal_node_pools_unenroll( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Unenrolls a bare metal node pool from Anthos On-Prem API.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the node pool to unenroll. Format: projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - 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. -
:etag
(type:String.t
) - 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. -
:validateOnly
(type:boolean()
) - If set, only validate the request, but do not actually unenroll the node pool.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new bare metal cluster in a given project and location.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location where the cluster is created in. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:bareMetalClusterId
(type:String.t
) - 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]$/ -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates. -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.BareMetalCluster.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a single bare metal Cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the bare metal user cluster to be deleted. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - 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. -
:etag
(type:String.t
) - 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. -
:force
(type:boolean()
) - If set to true, any node pools from the cluster will also be deleted. -
:ignoreErrors
(type:boolean()
) - 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. -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_enroll(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_enroll( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.EnrollBareMetalClusterRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.BareMetalCluster.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single bare metal Cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the bare metal user cluster to get. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:view
(type:String.t
) - View for bare metal user cluster. WhenBASIC
is specified, only the cluster resource name and admin cluster membership are returned. The default/unset valueCLUSTER_VIEW_UNSPECIFIED
is the same asFULL', which returns the complete cluster configuration details. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
-
gkeonprem_projects_locations_bare_metal_clusters_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Policy{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListBareMetalClustersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists bare metal clusters in a given project and location.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - A resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned. -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - A token identifying a page of results the server should return. -
:view
(type:String.t
) - View for bare metal Clusters. WhenBASIC
is specified, only the cluster resource name and admin cluster membership are returned. The default/unset valueCLUSTER_VIEW_UNSPECIFIED
is the same asFULL', which returns the complete cluster configuration details. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
-
gkeonprem_projects_locations_bare_metal_clusters_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the parameters of a single bare metal Cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Immutable. The bare metal user cluster resource name. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - 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. -
:updateMask
(type:String.t
) - 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. -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates. -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.BareMetalCluster.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_query_version_config(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_query_version_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.QueryBareMetalVersionConfigResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Queries the bare metal user cluster version config.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location to query for version config. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"createConfig.adminClusterMembership"
(type:String.t
) - The admin cluster membership. This is the full resource name of the admin cluster's fleet membership. Format: "projects/{project}/locations/{location}/memberships/{membership}" -
:"createConfig.adminClusterName"
(type:String.t
) - 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}" -
:"upgradeConfig.clusterName"
(type:String.t
) - 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}"
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.QueryBareMetalVersionConfigResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Policy{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_bare_metal_clusters_unenroll(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_bare_metal_clusters_unenroll( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the bare metal user cluster to be unenrolled. Format: "projects/{project}/locations/{location}/bareMetalClusters/{cluster}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - 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. -
:etag
(type:String.t
) - 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. -
:force
(type:boolean()
) - This is required if the cluster has any associated node pools. When set, any child node pools will also be unenrolled. -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Location.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets information about a location.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Resource name for the location. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Location{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists information about the supported locations for this service.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource that owns the locations collection, if applicable. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - 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. -
:pageSize
(type:integer()
) - The maximum number of results to return. If not set, the service selects a default. -
:pageToken
(type:String.t
) - A page token received from thenext_page_token
field in the response. Send that page token to receive the subsequent page.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.ListLocationsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_operations_cancel(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_operations_cancel( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource to be cancelled. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.CancelOperationRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Empty{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_operations_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_operations_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource to be deleted. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Empty{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_admin_clusters_enroll(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_admin_clusters_enroll( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.EnrollVmwareAdminClusterRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_admin_clusters_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_admin_clusters_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.VmwareAdminCluster.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single VMware admin cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the VMware admin cluster to be returned. Format: "projects/{project}/locations/{location}/vmwareAdminClusters/{vmware_admin_cluster}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:view
(type:String.t
) - View for VMware admin cluster. WhenBASIC
is specified, only the cluster resource name and membership are returned. The default/unset valueCLUSTER_VIEW_UNSPECIFIED
is the same asFULL', which returns the complete cluster configuration details. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
-
gkeonprem_projects_locations_vmware_admin_clusters_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_admin_clusters_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Policy{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_admin_clusters_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_admin_clusters_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListVmwareAdminClustersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists VMware admin clusters in a given project and location.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - A token identifying a page of results the server should return. -
:view
(type:String.t
) - View for VMware admin clusters. WhenBASIC
is specified, only the admin cluster resource name and membership are returned. The default/unset valueCLUSTER_VIEW_UNSPECIFIED
is the same asFULL', which returns the complete admin cluster configuration details. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
-
gkeonprem_projects_locations_vmware_admin_clusters_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_admin_clusters_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_admin_clusters_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_admin_clusters_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_admin_clusters_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_admin_clusters_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the parameters of a single VMware admin cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Immutable. The VMware admin cluster resource name. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - 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. -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates. -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.VmwareAdminCluster.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_admin_clusters_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_admin_clusters_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Policy{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_admin_clusters_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_admin_clusters_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_admin_clusters_unenroll(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_admin_clusters_unenroll( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the VMware admin cluster to be unenrolled. Format: "projects/{project}/locations/{location}/vmwareAdminClusters/{cluster}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - 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. -
:etag
(type:String.t
) - 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. -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new VMware user cluster in a given project and location.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location where this cluster is created in. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates. -
:vmwareClusterId
(type:String.t
) - 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. -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.VmwareCluster.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a single VMware Cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the VMware user cluster to be deleted. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - 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. -
:etag
(type:String.t
) - 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. -
:force
(type:boolean()
) - If set to true, any node pools from the cluster will also be deleted. -
:ignoreErrors
(type:boolean()
) - 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. -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_enroll(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_enroll( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location where the cluster is Enrolled in. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.EnrollVmwareClusterRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.VmwareCluster.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single VMware Cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the VMware user cluster to be returned. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:view
(type:String.t
) - View for VMware user cluster. WhenBASIC
is specified, only the cluster resource name and admin cluster membership are returned. The default/unset valueCLUSTER_VIEW_UNSPECIFIED
is the same asFULL', which returns the complete cluster configuration details. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
-
gkeonprem_projects_locations_vmware_clusters_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Policy{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListVmwareClustersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists VMware Clusters in a given project and location.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - A resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned. -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - A token identifying a page of results the server should return. -
:view
(type:String.t
) - View for VMware clusters. WhenBASIC
is specified, only the cluster resource name and admin cluster membership are returned. The default/unset valueCLUSTER_VIEW_UNSPECIFIED
is the same asFULL', which returns the complete cluster configuration details. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
-
gkeonprem_projects_locations_vmware_clusters_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the parameters of a single VMware cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Immutable. The VMware user cluster resource name. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - 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. -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates. -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.VmwareCluster.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_query_version_config(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_query_version_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.QueryVmwareVersionConfigResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Queries the VMware user cluster version config.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent of the project and location to query for version config. Format: "projects/{project}/locations/{location}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"createConfig.adminClusterMembership"
(type:String.t
) - The admin cluster membership. This is the full resource name of the admin cluster's fleet membership. Format: "projects/{project}/locations/{location}/memberships/{membership}" -
:"createConfig.adminClusterName"
(type:String.t
) - 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}" -
:"upgradeConfig.clusterName"
(type:String.t
) - The user cluster resource name. This is the full resource name of the user cluster resource. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}"
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.QueryVmwareVersionConfigResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Policy{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_unenroll(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_unenroll( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the VMware user cluster to be unenrolled. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - 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. -
:etag
(type:String.t
) - 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. -
:force
(type:boolean()
) - This is required if the cluster has any associated node pools. When set, any child node pools will also be unenrolled. -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new VMware node pool in a given project, location and VMWare cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/vmwareClusters/{cluster} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:validateOnly
(type:boolean()
) - If set, only validate the request, but do not actually create the node pool. -
:vmwareNodePoolId
(type:String.t
) - 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). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.VmwareNodePool.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a single VMware node pool.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the node pool to delete. Format: projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - 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. -
:etag
(type:String.t
) - 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. -
:ignoreErrors
(type:boolean()
) - 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. -
:validateOnly
(type:boolean()
) - If set, only validate the request, but do not actually delete the node pool.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_enroll(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_enroll( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Enrolls a VMware node pool to Anthos On-Prem API
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent resource where the node pool is enrolled in. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.EnrollVmwareNodePoolRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.VmwareNodePool.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single VMware node pool.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the node pool to retrieve. projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:view
(type:String.t
) - View for VMware node pool. WhenBASIC
is specified, only the node pool resource name is returned. The default/unset valueNODE_POOL_VIEW_UNSPECIFIED
is the same asFULL', which returns the complete node pool configuration details. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
-
gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Policy{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListVmwareNodePoolsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists VMware node pools in a given project, location and VMWare cluster.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent, which owns this collection of node pools. Format: projects/{project}/locations/{location}/vmwareClusters/{vmwareCluster} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - A page token, received from a previousListVmwareNodePools
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListVmwareNodePools
must match the call that provided the page token. -
:view
(type:String.t
) - View for VMware node pools. WhenBASIC
is specified, only the node pool resource name is returned. The default/unset valueNODE_POOL_VIEW_UNSPECIFIED
is the same asFULL', which returns the complete node pool configuration details. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure
-
gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.ListOperationsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the parameters of a single VMware node pool.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Immutable. The resource name of this node pool. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - 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. -
:validateOnly
(type:boolean()
) - Validate the request without actually doing any updates. -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.VmwareNodePool.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Policy{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_unenroll(connection, name, optional_params \\ [], opts \\ [])
View Source@spec gkeonprem_projects_locations_vmware_clusters_vmware_node_pools_unenroll( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GKEOnPrem.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Unenrolls a VMware node pool to Anthos On-Prem API
Parameters
-
connection
(type:GoogleApi.GKEOnPrem.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the node pool to unenroll. Format: projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nodepool} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - 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. -
:etag
(type:String.t
) - 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. -
:validateOnly
(type:boolean()
) - If set, only validate the request, but do not actually unenroll the node pool.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GKEOnPrem.V1.Model.Operation{}}
on success -
{:error, info}
on failure