Constructor
new NodeGroupControllerClient(optionsopt, gaxInstanceopt)
Construct an instance of NodeGroupControllerClient.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. The options accepted by the constructor are described in detail in this document. The common options are: Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
Members
apiEndpoint
The DNS address for this API service.
apiEndpoint
The DNS address for this API service - same as servicePath.
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
batchPath(project, location, batch) → {string}
Return a fully-qualified batch resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
batch |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
cancelOperation(request, optionsopt, callbackopt) → {Promise}
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:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
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 |
<optional> |
The function which will be called with the result of the API call. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```
(async) checkCreateNodeGroupProgress(name) → {Promise}
Check the status of the long running operation returned by createNodeGroup()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource where this node group will be created.
* Format: `projects/{project}/regions/{region}/clusters/{cluster}`
*/
// const parent = 'abc123'
/**
* Required. The node group to create.
*/
// const nodeGroup = {}
/**
* Optional. An optional node group ID. Generated if not specified.
* The ID must contain only letters (a-z, A-Z), numbers (0-9),
* underscores (_), and hyphens (-). Cannot begin or end with underscore
* or hyphen. Must consist of from 3 to 33 characters.
*/
// const nodeGroupId = 'abc123'
/**
* Optional. A unique ID used to identify the request. If the server receives
* two
* CreateNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateNodeGroupRequests)
* with the same ID, the second request is ignored and the
* first google.longrunning.Operation google.longrunning.Operation created
* and stored in the backend is returned.
* Recommendation: Set this value to a
* UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).
* The ID must contain only letters (a-z, A-Z), numbers (0-9),
* underscores (_), and hyphens (-). The maximum length is 40 characters.
*/
// const requestId = 'abc123'
// Imports the Dataproc library
const {NodeGroupControllerClient} = require('@google-cloud/dataproc').v1;
// Instantiates a client
const dataprocClient = new NodeGroupControllerClient();
async function callCreateNodeGroup() {
// Construct request
const request = {
parent,
nodeGroup,
};
// Run request
const [operation] = await dataprocClient.createNodeGroup(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateNodeGroup();
(async) checkResizeNodeGroupProgress(name) → {Promise}
Check the status of the long running operation returned by resizeNodeGroup()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the node group to resize.
* Format:
* `projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}`
*/
// const name = 'abc123'
/**
* Required. The number of running instances for the node group to maintain.
* The group adds or removes instances to maintain the number of instances
* specified by this parameter.
*/
// const size = 1234
/**
* Optional. A unique ID used to identify the request. If the server receives
* two
* ResizeNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.ResizeNodeGroupRequests)
* with the same ID, the second request is ignored and the
* first google.longrunning.Operation google.longrunning.Operation created
* and stored in the backend is returned.
* Recommendation: Set this value to a
* UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).
* The ID must contain only letters (a-z, A-Z), numbers (0-9),
* underscores (_), and hyphens (-). The maximum length is 40 characters.
*/
// const requestId = 'abc123'
/**
* Optional. Timeout for graceful YARN decommissioning. Graceful
* decommissioning
* (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/scaling-clusters#graceful_decommissioning)
* allows the removal of nodes from the Compute Engine node group
* without interrupting jobs in progress. This timeout specifies how long to
* wait for jobs in progress to finish before forcefully removing nodes (and
* potentially interrupting jobs). Default timeout is 0 (for forceful
* decommission), and the maximum allowed timeout is 1 day. (see JSON
* representation of
* Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
* Only supported on Dataproc image versions 1.2 and higher.
*/
// const gracefulDecommissionTimeout = {}
// Imports the Dataproc library
const {NodeGroupControllerClient} = require('@google-cloud/dataproc').v1;
// Instantiates a client
const dataprocClient = new NodeGroupControllerClient();
async function callResizeNodeGroup() {
// Construct request
const request = {
name,
size,
};
// Run request
const [operation] = await dataprocClient.resizeNodeGroup(request);
const [response] = await operation.promise();
console.log(response);
}
callResizeNodeGroup();
close() → {Promise}
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves when the client is closed. |
clusterRegionPath(project, region, cluster) → {string}
Return a fully-qualified clusterRegion resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
region |
string | |
cluster |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
deleteOperation(request, optionsopt, callbackopt) → {Promise}
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:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
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 |
<optional> |
The function which will be called with the result of the API call. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```
getIamPolicy(request, optionsopt, callbackopt) → {Promise}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
Object |
<optional> |
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 |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Policy. |
Returns:
Type | Description |
---|---|
Promise |
|
getOperation(request, optionsopt, callbackopt) → {Promise}
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:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
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 |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing google.longrunning.Operation. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
initialize() → {Promise}
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to an authenticated service stub. |
listOperationsAsync(request, optionsopt) → {Object}
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that conforms to iteration protocols. |
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```
matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName) → {string}
Parse the autoscaling_policy from ProjectLocationAutoscalingPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
projectLocationAutoscalingPolicyName |
string |
A fully-qualified path representing project_location_autoscaling_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the autoscaling_policy. |
matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName) → {string}
Parse the autoscaling_policy from ProjectRegionAutoscalingPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
projectRegionAutoscalingPolicyName |
string |
A fully-qualified path representing project_region_autoscaling_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the autoscaling_policy. |
matchBatchFromBatchName(batchName) → {string}
Parse the batch from Batch resource.
Parameters:
Name | Type | Description |
---|---|---|
batchName |
string |
A fully-qualified path representing Batch resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the batch. |
matchClusterFromClusterRegionName(clusterRegionName) → {string}
Parse the cluster from ClusterRegion resource.
Parameters:
Name | Type | Description |
---|---|---|
clusterRegionName |
string |
A fully-qualified path representing ClusterRegion resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the cluster. |
matchClusterFromNodeGroupName(nodeGroupName) → {string}
Parse the cluster from NodeGroup resource.
Parameters:
Name | Type | Description |
---|---|---|
nodeGroupName |
string |
A fully-qualified path representing NodeGroup resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the cluster. |
matchLocationFromBatchName(batchName) → {string}
Parse the location from Batch resource.
Parameters:
Name | Type | Description |
---|---|---|
batchName |
string |
A fully-qualified path representing Batch resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName) → {string}
Parse the location from ProjectLocationAutoscalingPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
projectLocationAutoscalingPolicyName |
string |
A fully-qualified path representing project_location_autoscaling_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName) → {string}
Parse the location from ProjectLocationWorkflowTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
projectLocationWorkflowTemplateName |
string |
A fully-qualified path representing project_location_workflow_template resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromSessionName(sessionName) → {string}
Parse the location from Session resource.
Parameters:
Name | Type | Description |
---|---|---|
sessionName |
string |
A fully-qualified path representing Session resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromSessionTemplateName(sessionTemplateName) → {string}
Parse the location from SessionTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
sessionTemplateName |
string |
A fully-qualified path representing SessionTemplate resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchNodeGroupFromNodeGroupName(nodeGroupName) → {string}
Parse the node_group from NodeGroup resource.
Parameters:
Name | Type | Description |
---|---|---|
nodeGroupName |
string |
A fully-qualified path representing NodeGroup resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the node_group. |
matchProjectFromBatchName(batchName) → {string}
Parse the project from Batch resource.
Parameters:
Name | Type | Description |
---|---|---|
batchName |
string |
A fully-qualified path representing Batch resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromClusterRegionName(clusterRegionName) → {string}
Parse the project from ClusterRegion resource.
Parameters:
Name | Type | Description |
---|---|---|
clusterRegionName |
string |
A fully-qualified path representing ClusterRegion resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromNodeGroupName(nodeGroupName) → {string}
Parse the project from NodeGroup resource.
Parameters:
Name | Type | Description |
---|---|---|
nodeGroupName |
string |
A fully-qualified path representing NodeGroup resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName) → {string}
Parse the project from ProjectLocationAutoscalingPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
projectLocationAutoscalingPolicyName |
string |
A fully-qualified path representing project_location_autoscaling_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName) → {string}
Parse the project from ProjectLocationWorkflowTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
projectLocationWorkflowTemplateName |
string |
A fully-qualified path representing project_location_workflow_template resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectName(projectName) → {string}
Parse the project from Project resource.
Parameters:
Name | Type | Description |
---|---|---|
projectName |
string |
A fully-qualified path representing Project resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName) → {string}
Parse the project from ProjectRegionAutoscalingPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
projectRegionAutoscalingPolicyName |
string |
A fully-qualified path representing project_region_autoscaling_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName) → {string}
Parse the project from ProjectRegionWorkflowTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
projectRegionWorkflowTemplateName |
string |
A fully-qualified path representing project_region_workflow_template resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromRegionName(regionName) → {string}
Parse the project from Region resource.
Parameters:
Name | Type | Description |
---|---|---|
regionName |
string |
A fully-qualified path representing Region resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromSessionName(sessionName) → {string}
Parse the project from Session resource.
Parameters:
Name | Type | Description |
---|---|---|
sessionName |
string |
A fully-qualified path representing Session resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromSessionTemplateName(sessionTemplateName) → {string}
Parse the project from SessionTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
sessionTemplateName |
string |
A fully-qualified path representing SessionTemplate resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchRegionFromClusterRegionName(clusterRegionName) → {string}
Parse the region from ClusterRegion resource.
Parameters:
Name | Type | Description |
---|---|---|
clusterRegionName |
string |
A fully-qualified path representing ClusterRegion resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the region. |
matchRegionFromNodeGroupName(nodeGroupName) → {string}
Parse the region from NodeGroup resource.
Parameters:
Name | Type | Description |
---|---|---|
nodeGroupName |
string |
A fully-qualified path representing NodeGroup resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the region. |
matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName) → {string}
Parse the region from ProjectRegionAutoscalingPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
projectRegionAutoscalingPolicyName |
string |
A fully-qualified path representing project_region_autoscaling_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the region. |
matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName) → {string}
Parse the region from ProjectRegionWorkflowTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
projectRegionWorkflowTemplateName |
string |
A fully-qualified path representing project_region_workflow_template resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the region. |
matchRegionFromRegionName(regionName) → {string}
Parse the region from Region resource.
Parameters:
Name | Type | Description |
---|---|---|
regionName |
string |
A fully-qualified path representing Region resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the region. |
matchSessionFromSessionName(sessionName) → {string}
Parse the session from Session resource.
Parameters:
Name | Type | Description |
---|---|---|
sessionName |
string |
A fully-qualified path representing Session resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the session. |
matchTemplateFromSessionTemplateName(sessionTemplateName) → {string}
Parse the template from SessionTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
sessionTemplateName |
string |
A fully-qualified path representing SessionTemplate resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the template. |
matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName) → {string}
Parse the workflow_template from ProjectLocationWorkflowTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
projectLocationWorkflowTemplateName |
string |
A fully-qualified path representing project_location_workflow_template resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the workflow_template. |
matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName) → {string}
Parse the workflow_template from ProjectRegionWorkflowTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
projectRegionWorkflowTemplateName |
string |
A fully-qualified path representing project_region_workflow_template resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the workflow_template. |
nodeGroupPath(project, region, cluster, node_group) → {string}
Return a fully-qualified nodeGroup resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
region |
string | |
cluster |
string | |
node_group |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectLocationAutoscalingPolicyPath(project, location, autoscaling_policy) → {string}
Return a fully-qualified projectLocationAutoscalingPolicy resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
autoscaling_policy |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectLocationWorkflowTemplatePath(project, location, workflow_template) → {string}
Return a fully-qualified projectLocationWorkflowTemplate resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
workflow_template |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectPath(project) → {string}
Return a fully-qualified project resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectRegionAutoscalingPolicyPath(project, region, autoscaling_policy) → {string}
Return a fully-qualified projectRegionAutoscalingPolicy resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
region |
string | |
autoscaling_policy |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectRegionWorkflowTemplatePath(project, region, workflow_template) → {string}
Return a fully-qualified projectRegionWorkflowTemplate resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
region |
string | |
workflow_template |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
regionPath(project, region) → {string}
Return a fully-qualified region resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
region |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
sessionPath(project, location, session) → {string}
Return a fully-qualified session resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
session |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
sessionTemplatePath(project, location, template) → {string}
Return a fully-qualified sessionTemplate resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
template |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
setIamPolicy(request, optionsopt, callbackopt) → {Promise}
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:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
options |
Object |
<optional> |
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 |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing TestIamPermissionsResponse. |
Returns:
Type | Description |
---|---|
Promise |
|
testIamPermissions(request, optionsopt, callbackopt) → {Promise}
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:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
options |
Object |
<optional> |
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 |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing TestIamPermissionsResponse. |
Returns:
Type | Description |
---|---|
Promise |
|