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

public class NodeTemplatesClient : ClientBase<NodeTemplates.NodeTemplatesClient>

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

Client for NodeTemplates

Inheritance

Object > ClientBase > ClientBase<NodeTemplates.NodeTemplatesClient> > NodeTemplates.NodeTemplatesClient

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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

NodeTemplatesClient(ChannelBase)

public NodeTemplatesClient(ChannelBase channel)

Creates a new client for NodeTemplates

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

NodeTemplatesClient(ClientBase.ClientBaseConfiguration)

protected NodeTemplatesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListNodeTemplatesRequest, CallOptions)

public virtual NodeTemplateAggregatedList AggregatedList(AggregatedListNodeTemplatesRequest request, CallOptions options)

Retrieves an aggregated list of node templates.

Parameters
NameDescription
requestAggregatedListNodeTemplatesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
NodeTemplateAggregatedList

The response received from the server.

AggregatedList(AggregatedListNodeTemplatesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves an aggregated list of node templates.

Parameters
NameDescription
requestAggregatedListNodeTemplatesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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.

Parameters
NameDescription
requestAggregatedListNodeTemplatesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<NodeTemplateAggregatedList>

The call object.

AggregatedListAsync(AggregatedListNodeTemplatesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves an aggregated list of node templates.

Parameters
NameDescription
requestAggregatedListNodeTemplatesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<NodeTemplateAggregatedList>

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
TypeDescription
Operations.OperationsClient

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
NameDescription
requestDeleteNodeTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteNodeTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified NodeTemplate resource.

Parameters
NameDescription
requestDeleteNodeTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestDeleteNodeTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteAsync(DeleteNodeTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified NodeTemplate resource.

Parameters
NameDescription
requestDeleteNodeTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

Get(GetNodeTemplateRequest, CallOptions)

public virtual NodeTemplate Get(GetNodeTemplateRequest request, CallOptions options)

Returns the specified node template. Gets a list of available node templates by making a list() request.

Parameters
NameDescription
requestGetNodeTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
NodeTemplate

The response received from the server.

Get(GetNodeTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the specified node template. Gets a list of available node templates by making a list() request.

Parameters
NameDescription
requestGetNodeTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
NodeTemplate

The response received from the server.

GetAsync(GetNodeTemplateRequest, CallOptions)

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

Returns the specified node template. Gets a list of available node templates by making a list() request.

Parameters
NameDescription
requestGetNodeTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<NodeTemplate>

The call object.

GetAsync(GetNodeTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the specified node template. Gets a list of available node templates by making a list() request.

Parameters
NameDescription
requestGetNodeTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<NodeTemplate>

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
NameDescription
requestGetIamPolicyNodeTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

GetIamPolicy(GetIamPolicyNodeTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestGetIamPolicyNodeTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestGetIamPolicyNodeTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

GetIamPolicyAsync(GetIamPolicyNodeTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestGetIamPolicyNodeTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

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
NameDescription
requestInsertNodeTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertNodeTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestInsertNodeTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestInsertNodeTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

InsertAsync(InsertNodeTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestInsertNodeTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

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
NameDescription
requestListNodeTemplatesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
NodeTemplateList

The response received from the server.

List(ListNodeTemplatesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestListNodeTemplatesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListNodeTemplatesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<NodeTemplateList>

The call object.

ListAsync(ListNodeTemplatesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestListNodeTemplatesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<NodeTemplateList>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
NodeTemplates.NodeTemplatesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.NodeTemplates.NodeTemplatesClient>.NewInstance(Grpc.Core.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
NameDescription
requestSetIamPolicyNodeTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

SetIamPolicy(SetIamPolicyNodeTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestSetIamPolicyNodeTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestSetIamPolicyNodeTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

SetIamPolicyAsync(SetIamPolicyNodeTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestSetIamPolicyNodeTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

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
NameDescription
requestTestIamPermissionsNodeTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TestPermissionsResponse

The response received from the server.

TestIamPermissions(TestIamPermissionsNodeTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsNodeTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestTestIamPermissionsNodeTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TestPermissionsResponse>

The call object.

TestIamPermissionsAsync(TestIamPermissionsNodeTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsNodeTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<TestPermissionsResponse>

The call object.