Compute Engine v1 API - Class NodeTemplates.NodeTemplatesClient (2.16.0)

Version 2.16.0

• 3.0.0 (latest)
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class NodeTemplates.NodeTemplatesClient : ClientBase<NodeTemplates.NodeTemplatesClient>

Reference documentation and code samples for the Compute Engine v1 API class NodeTemplates.NodeTemplatesClient.

Client for NodeTemplates

Inheritance

object > ClientBase > ClientBaseNodeTemplatesNodeTemplatesClient > NodeTemplates.NodeTemplatesClient

Inherited Members

ClientBase<NodeTemplates.NodeTemplatesClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

NodeTemplatesClient()

protected NodeTemplatesClient()

Protected parameterless constructor to allow creation of test doubles.

NodeTemplatesClient(CallInvoker)

public NodeTemplatesClient(CallInvoker callInvoker)

Creates a new client for NodeTemplates that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

NodeTemplatesClient(ChannelBase)

public NodeTemplatesClient(ChannelBase channel)

Creates a new client for NodeTemplates

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

NodeTemplatesClient(ClientBaseConfiguration)

protected NodeTemplatesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListNodeTemplatesRequest, CallOptions)

public virtual NodeTemplateAggregatedList AggregatedList(AggregatedListNodeTemplatesRequest request, CallOptions options)

Retrieves an aggregated list of node templates. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListNodeTemplatesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
NodeTemplateAggregatedList	The response received from the server.

AggregatedList(AggregatedListNodeTemplatesRequest, Metadata, DateTime?, CancellationToken)

public virtual NodeTemplateAggregatedList AggregatedList(AggregatedListNodeTemplatesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves an aggregated list of node templates. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListNodeTemplatesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
NodeTemplateAggregatedList	The response received from the server.

AggregatedListAsync(AggregatedListNodeTemplatesRequest, CallOptions)

public virtual AsyncUnaryCall<NodeTemplateAggregatedList> AggregatedListAsync(AggregatedListNodeTemplatesRequest request, CallOptions options)

Retrieves an aggregated list of node templates. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListNodeTemplatesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallNodeTemplateAggregatedList	The call object.

AggregatedListAsync(AggregatedListNodeTemplatesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NodeTemplateAggregatedList> AggregatedListAsync(AggregatedListNodeTemplatesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves an aggregated list of node templates. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListNodeTemplatesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallNodeTemplateAggregatedList	The call object.

CreateOperationsClientForRegionOperations()

public virtual Operations.OperationsClient CreateOperationsClientForRegionOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to RegionOperations.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

Delete(DeleteNodeTemplateRequest, CallOptions)

public virtual Operation Delete(DeleteNodeTemplateRequest request, CallOptions options)

Deletes the specified NodeTemplate resource.

Parameters
Name	Description
request	DeleteNodeTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Delete(DeleteNodeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Delete(DeleteNodeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified NodeTemplate resource.

Parameters
Name	Description
request	DeleteNodeTemplateRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteAsync(DeleteNodeTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteNodeTemplateRequest request, CallOptions options)

Deletes the specified NodeTemplate resource.

Parameters
Name	Description
request	DeleteNodeTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteNodeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteNodeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified NodeTemplate resource.

Parameters
Name	Description
request	DeleteNodeTemplateRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

Get(GetNodeTemplateRequest, CallOptions)

public virtual NodeTemplate Get(GetNodeTemplateRequest request, CallOptions options)

Returns the specified node template.

Parameters
Name	Description
request	GetNodeTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
NodeTemplate	The response received from the server.

Get(GetNodeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual NodeTemplate Get(GetNodeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified node template.

Parameters
Name	Description
request	GetNodeTemplateRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
NodeTemplate	The response received from the server.

GetAsync(GetNodeTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<NodeTemplate> GetAsync(GetNodeTemplateRequest request, CallOptions options)

Returns the specified node template.

Parameters
Name	Description
request	GetNodeTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallNodeTemplate	The call object.

GetAsync(GetNodeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NodeTemplate> GetAsync(GetNodeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified node template.

Parameters
Name	Description
request	GetNodeTemplateRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallNodeTemplate	The call object.

GetIamPolicy(GetIamPolicyNodeTemplateRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyNodeTemplateRequest request, CallOptions options)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name	Description
request	GetIamPolicyNodeTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicy(GetIamPolicyNodeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyNodeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name	Description
request	GetIamPolicyNodeTemplateRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicyAsync(GetIamPolicyNodeTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyNodeTemplateRequest request, CallOptions options)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name	Description
request	GetIamPolicyNodeTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

GetIamPolicyAsync(GetIamPolicyNodeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyNodeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name	Description
request	GetIamPolicyNodeTemplateRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

Insert(InsertNodeTemplateRequest, CallOptions)

public virtual Operation Insert(InsertNodeTemplateRequest request, CallOptions options)

Creates a NodeTemplate resource in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertNodeTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Insert(InsertNodeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Insert(InsertNodeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a NodeTemplate resource in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertNodeTemplateRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

InsertAsync(InsertNodeTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertNodeTemplateRequest request, CallOptions options)

Creates a NodeTemplate resource in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertNodeTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertNodeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertNodeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a NodeTemplate resource in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertNodeTemplateRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

List(ListNodeTemplatesRequest, CallOptions)

public virtual NodeTemplateList List(ListNodeTemplatesRequest request, CallOptions options)

Retrieves a list of node templates available to the specified project.

Parameters
Name	Description
request	ListNodeTemplatesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
NodeTemplateList	The response received from the server.

List(ListNodeTemplatesRequest, Metadata, DateTime?, CancellationToken)

public virtual NodeTemplateList List(ListNodeTemplatesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a list of node templates available to the specified project.

Parameters
Name	Description
request	ListNodeTemplatesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
NodeTemplateList	The response received from the server.

ListAsync(ListNodeTemplatesRequest, CallOptions)

public virtual AsyncUnaryCall<NodeTemplateList> ListAsync(ListNodeTemplatesRequest request, CallOptions options)

Retrieves a list of node templates available to the specified project.

Parameters
Name	Description
request	ListNodeTemplatesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallNodeTemplateList	The call object.

ListAsync(ListNodeTemplatesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NodeTemplateList> ListAsync(ListNodeTemplatesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a list of node templates available to the specified project.

Parameters
Name	Description
request	ListNodeTemplatesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallNodeTemplateList	The call object.

NewInstance(ClientBaseConfiguration)

protected override NodeTemplates.NodeTemplatesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
NodeTemplatesNodeTemplatesClient

Overrides

ClientBase<NodeTemplates.NodeTemplatesClient>.NewInstance(ClientBase.ClientBaseConfiguration)

SetIamPolicy(SetIamPolicyNodeTemplateRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyNodeTemplateRequest request, CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name	Description
request	SetIamPolicyNodeTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicy(SetIamPolicyNodeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyNodeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name	Description
request	SetIamPolicyNodeTemplateRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicyAsync(SetIamPolicyNodeTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyNodeTemplateRequest request, CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name	Description
request	SetIamPolicyNodeTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

SetIamPolicyAsync(SetIamPolicyNodeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyNodeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name	Description
request	SetIamPolicyNodeTemplateRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

TestIamPermissions(TestIamPermissionsNodeTemplateRequest, CallOptions)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsNodeTemplateRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsNodeTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TestPermissionsResponse	The response received from the server.

TestIamPermissions(TestIamPermissionsNodeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsNodeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsNodeTemplateRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
TestPermissionsResponse	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsNodeTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsNodeTemplateRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsNodeTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTestPermissionsResponse	The call object.

TestIamPermissionsAsync(TestIamPermissionsNodeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsNodeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsNodeTemplateRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallTestPermissionsResponse	The call object.