v1.
Source: v1/
Google Kubernetes Engine Cluster Manager v1
Properties
Methods
- cancelOperation(request[, options][, callback])
- completeIPRotation(request[, options][, callback])
- createCluster(request[, options][, callback])
- createNodePool(request[, options][, callback])
- deleteCluster(request[, options][, callback])
- deleteNodePool(request[, options][, callback])
- getCluster(request[, options][, callback])
- getNodePool(request[, options][, callback])
- getOperation(request[, options][, callback])
- getProjectId(callback)
- getServerConfig(request[, options][, callback])
- listClusters(request[, options][, callback])
- listNodePools(request[, options][, callback])
- listOperations(request[, options][, callback])
- rollbackNodePoolUpgrade(request[, options][, callback])
- setAddonsConfig(request[, options][, callback])
- setLabels(request[, options][, callback])
- setLegacyAbac(request[, options][, callback])
- setLocations(request[, options][, callback])
- setLoggingService(request[, options][, callback])
- setMaintenancePolicy(request[, options][, callback])
- setMasterAuth(request[, options][, callback])
- setMonitoringService(request[, options][, callback])
- setNetworkPolicy(request[, options][, callback])
- setNodePoolAutoscaling(request[, options][, callback])
- setNodePoolManagement(request[, options][, callback])
- setNodePoolSize(request[, options][, callback])
- startIPRotation(request[, options][, callback])
- updateCluster(request[, options][, callback])
- updateMaster(request[, options][, callback])
- updateNodePool(request[, options][, callback])
new ClusterManagerClient([options])
Construct an instance of ClusterManagerClient.
Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
options |
|
Yes |
The configuration object. See the subsequent parameters for more details. Values in
|
Properties
apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
cancelOperation(request[, options][, callback]) → Promise
Cancels the specified operation.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const operationId = '';
const request = {
projectId: projectId,
zone: zone,
operationId: operationId,
};
client.cancelOperation(request).catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||
|
callback |
function(nullable Error) |
Yes |
The function which will be called with the result of the API call. |
- Returns
Promise- The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
completeIPRotation(request[, options][, callback]) → Promise
Completes master IP rotation.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
};
client.completeIPRotation(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
createCluster(request[, options][, callback]) → Promise
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances.
By default, the cluster is created in the project's default network.
One firewall is added for the cluster. After cluster creation, the cluster creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster.
Finally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const cluster = {};
const request = {
projectId: projectId,
zone: zone,
cluster: cluster,
};
client.createCluster(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
createNodePool(request[, options][, callback]) → Promise
Creates a node pool for a cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const nodePool = {};
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
nodePool: nodePool,
};
client.createNodePool(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
deleteCluster(request[, options][, callback]) → Promise
Deletes the cluster, including the Kubernetes endpoint and all worker nodes.
Firewalls and routes that were configured during cluster creation are also deleted.
Other Google Compute Engine resources that might be in use by the cluster (e.g. load balancer resources) will not be deleted if they weren't present at the initial create time.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
};
client.deleteCluster(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
deleteNodePool(request[, options][, callback]) → Promise
Deletes a node pool from a cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const nodePoolId = '';
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
nodePoolId: nodePoolId,
};
client.deleteNodePool(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
getCluster(request[, options][, callback]) → Promise
Gets the details of a specific cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
};
client.getCluster(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Cluster. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Cluster. The promise has a method named "cancel" which cancels the ongoing API call.
getNodePool(request[, options][, callback]) → Promise
Retrieves the node pool requested.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const nodePoolId = '';
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
nodePoolId: nodePoolId,
};
client.getNodePool(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing NodePool. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing NodePool. The promise has a method named "cancel" which cancels the ongoing API call.
getOperation(request[, options][, callback]) → Promise
Gets the specified operation.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const operationId = '';
const request = {
projectId: projectId,
zone: zone,
operationId: operationId,
};
client.getOperation(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
getProjectId(callback)
Return the project ID used by this class.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
callback |
function(Error, string) |
|
the callback to be called with the current project Id. |
getServerConfig(request[, options][, callback]) → Promise
Returns configuration info about the Kubernetes Engine service.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const request = {
projectId: projectId,
zone: zone,
};
client.getServerConfig(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing ServerConfig. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing ServerConfig. The promise has a method named "cancel" which cancels the ongoing API call.
listClusters(request[, options][, callback]) → Promise
Lists all clusters owned by a project in either the specified zone or all zones.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const request = {
projectId: projectId,
zone: zone,
};
client.listClusters(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing ListClustersResponse. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing ListClustersResponse. The promise has a method named "cancel" which cancels the ongoing API call.
listNodePools(request[, options][, callback]) → Promise
Lists the node pools for a cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
};
client.listNodePools(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing ListNodePoolsResponse. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing ListNodePoolsResponse. The promise has a method named "cancel" which cancels the ongoing API call.
listOperations(request[, options][, callback]) → Promise
Lists all operations in a project in a specific zone or all zones.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const request = {
projectId: projectId,
zone: zone,
};
client.listOperations(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing ListOperationsResponse. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing ListOperationsResponse. The promise has a method named "cancel" which cancels the ongoing API call.
rollbackNodePoolUpgrade(request[, options][, callback]) → Promise
Roll back the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const nodePoolId = '';
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
nodePoolId: nodePoolId,
};
client.rollbackNodePoolUpgrade(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
setAddonsConfig(request[, options][, callback]) → Promise
Sets the addons for a specific cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const addonsConfig = {};
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
addonsConfig: addonsConfig,
};
client.setAddonsConfig(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
setLabels(request[, options][, callback]) → Promise
Sets labels on a cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const resourceLabels = {};
const labelFingerprint = '';
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
resourceLabels: resourceLabels,
labelFingerprint: labelFingerprint,
};
client.setLabels(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
setLegacyAbac(request[, options][, callback]) → Promise
Enables or disables the ABAC authorization mechanism on a cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const enabled = false;
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
enabled: enabled,
};
client.setLegacyAbac(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
setLocations(request[, options][, callback]) → Promise
Sets the locations for a specific cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const locations = [];
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
locations: locations,
};
client.setLocations(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
setLoggingService(request[, options][, callback]) → Promise
Sets the logging service for a specific cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const loggingService = '';
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
loggingService: loggingService,
};
client.setLoggingService(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
setMaintenancePolicy(request[, options][, callback]) → Promise
Sets the maintenance policy for a cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const maintenancePolicy = {};
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
maintenancePolicy: maintenancePolicy,
};
client.setMaintenancePolicy(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
setMasterAuth(request[, options][, callback]) → Promise
Used to set master auth materials. Currently supports :- Changing the admin password for a specific cluster. This can be either via password generation or explicitly set the password.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const action = 'UNKNOWN';
const update = {};
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
action: action,
update: update,
};
client.setMasterAuth(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
setMonitoringService(request[, options][, callback]) → Promise
Sets the monitoring service for a specific cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const monitoringService = '';
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
monitoringService: monitoringService,
};
client.setMonitoringService(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
setNetworkPolicy(request[, options][, callback]) → Promise
Enables/Disables Network Policy for a cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const networkPolicy = {};
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
networkPolicy: networkPolicy,
};
client.setNetworkPolicy(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
setNodePoolAutoscaling(request[, options][, callback]) → Promise
Sets the autoscaling settings for a specific node pool.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const nodePoolId = '';
const autoscaling = {};
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
nodePoolId: nodePoolId,
autoscaling: autoscaling,
};
client.setNodePoolAutoscaling(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
setNodePoolManagement(request[, options][, callback]) → Promise
Sets the NodeManagement options for a node pool.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const nodePoolId = '';
const management = {};
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
nodePoolId: nodePoolId,
management: management,
};
client.setNodePoolManagement(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
setNodePoolSize(request[, options][, callback]) → Promise
Sets the size for a specific node pool.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const nodePoolId = '';
const nodeCount = 0;
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
nodePoolId: nodePoolId,
nodeCount: nodeCount,
};
client.setNodePoolSize(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
startIPRotation(request[, options][, callback]) → Promise
Start master IP rotation.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
};
client.startIPRotation(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
updateCluster(request[, options][, callback]) → Promise
Updates the settings of a specific cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const update = {};
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
update: update,
};
client.updateCluster(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
updateMaster(request[, options][, callback]) → Promise
Updates the master for a specific cluster.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const masterVersion = '';
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
masterVersion: masterVersion,
};
client.updateMaster(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.
updateNodePool(request[, options][, callback]) → Promise
Updates the version and/or image type for a specific node pool.
Example
const container = require('@google-cloud/container');
const client = new container.v1.ClusterManagerClient({
// optional auth parameters.
});
const projectId = '';
const zone = '';
const clusterId = '';
const nodePoolId = '';
const nodeVersion = '';
const imageType = '';
const request = {
projectId: projectId,
zone: zone,
clusterId: clusterId,
nodePoolId: nodePoolId,
nodeVersion: nodeVersion,
imageType: imageType,
};
client.updateNodePool(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Operation. |
- Returns
Promise- The promise which resolves to an array. The first element of the array is an object representing Operation. The promise has a method named "cancel" which cancels the ongoing API call.