Compute Engine v1 API - Class SnapshotSettingsServiceClient (3.2.0)

Version latest

• 3.2.0 (latest)
• 3.1.0
• 3.0.0
• 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 abstract class SnapshotSettingsServiceClient

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

SnapshotSettingsService client wrapper, for convenient use.

Inheritance

object > SnapshotSettingsServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

SnapshotSettingsServiceClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The SnapshotSettings API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the SnapshotSettingsService service, which is a host of "compute.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default SnapshotSettingsService scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default SnapshotSettingsService scopes are:

• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual SnapshotSettingsService.SnapshotSettingsServiceClient GrpcClient { get; }

The underlying gRPC SnapshotSettingsService client

Property Value
Type	Description
SnapshotSettingsServiceSnapshotSettingsServiceClient

PatchOperationsClient

public virtual OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type	Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

Create()

public static SnapshotSettingsServiceClient Create()

Synchronously creates a SnapshotSettingsServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use SnapshotSettingsServiceClientBuilder.

Returns
Type	Description
SnapshotSettingsServiceClient	The created SnapshotSettingsServiceClient.

CreateAsync(CancellationToken)

public static Task<SnapshotSettingsServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a SnapshotSettingsServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use SnapshotSettingsServiceClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskSnapshotSettingsServiceClient	The task representing the created SnapshotSettingsServiceClient.

Get(GetSnapshotSettingRequest, CallSettings)

public virtual SnapshotSettings Get(GetSnapshotSettingRequest request, CallSettings callSettings = null)

Get snapshot settings.

Parameters
Name	Description
request	GetSnapshotSettingRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
SnapshotSettings	The RPC response.

Example

// Create client
SnapshotSettingsServiceClient snapshotSettingsServiceClient = SnapshotSettingsServiceClient.Create();
// Initialize request argument(s)
GetSnapshotSettingRequest request = new GetSnapshotSettingRequest { Project = "", };
// Make the request
SnapshotSettings response = snapshotSettingsServiceClient.Get(request);

Get(string, CallSettings)

public virtual SnapshotSettings Get(string project, CallSettings callSettings = null)

Get snapshot settings.

Parameters
Name	Description
project	string Project ID for this request.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
SnapshotSettings	The RPC response.

Example

// Create client
SnapshotSettingsServiceClient snapshotSettingsServiceClient = SnapshotSettingsServiceClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
SnapshotSettings response = snapshotSettingsServiceClient.Get(project);

GetAsync(GetSnapshotSettingRequest, CallSettings)

public virtual Task<SnapshotSettings> GetAsync(GetSnapshotSettingRequest request, CallSettings callSettings = null)

Get snapshot settings.

Parameters
Name	Description
request	GetSnapshotSettingRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskSnapshotSettings	A Task containing the RPC response.

Example

// Create client
SnapshotSettingsServiceClient snapshotSettingsServiceClient = await SnapshotSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
GetSnapshotSettingRequest request = new GetSnapshotSettingRequest { Project = "", };
// Make the request
SnapshotSettings response = await snapshotSettingsServiceClient.GetAsync(request);

GetAsync(GetSnapshotSettingRequest, CancellationToken)

public virtual Task<SnapshotSettings> GetAsync(GetSnapshotSettingRequest request, CancellationToken cancellationToken)

Get snapshot settings.

Parameters
Name	Description
request	GetSnapshotSettingRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskSnapshotSettings	A Task containing the RPC response.

Example

// Create client
SnapshotSettingsServiceClient snapshotSettingsServiceClient = await SnapshotSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
GetSnapshotSettingRequest request = new GetSnapshotSettingRequest { Project = "", };
// Make the request
SnapshotSettings response = await snapshotSettingsServiceClient.GetAsync(request);

GetAsync(string, CallSettings)

public virtual Task<SnapshotSettings> GetAsync(string project, CallSettings callSettings = null)

Get snapshot settings.

Parameters
Name	Description
project	string Project ID for this request.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskSnapshotSettings	A Task containing the RPC response.

Example

// Create client
SnapshotSettingsServiceClient snapshotSettingsServiceClient = await SnapshotSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
SnapshotSettings response = await snapshotSettingsServiceClient.GetAsync(project);

GetAsync(string, CancellationToken)

public virtual Task<SnapshotSettings> GetAsync(string project, CancellationToken cancellationToken)

Get snapshot settings.

Parameters
Name	Description
project	string Project ID for this request.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskSnapshotSettings	A Task containing the RPC response.

Example

// Create client
SnapshotSettingsServiceClient snapshotSettingsServiceClient = await SnapshotSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
SnapshotSettings response = await snapshotSettingsServiceClient.GetAsync(project);

Patch(PatchSnapshotSettingRequest, CallSettings)

public virtual Operation<Operation, Operation> Patch(PatchSnapshotSettingRequest request, CallSettings callSettings = null)

Patch snapshot settings.

Parameters
Name	Description
request	PatchSnapshotSettingRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
SnapshotSettingsServiceClient snapshotSettingsServiceClient = SnapshotSettingsServiceClient.Create();
// Initialize request argument(s)
PatchSnapshotSettingRequest request = new PatchSnapshotSettingRequest
{
    RequestId = "",
    Project = "",
    SnapshotSettingsResource = new SnapshotSettings(),
    UpdateMask = "",
};
// Make the request
lro::Operation<Operation, Operation> response = snapshotSettingsServiceClient.Patch(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = snapshotSettingsServiceClient.PollOncePatch(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Patch(string, SnapshotSettings, CallSettings)

public virtual Operation<Operation, Operation> Patch(string project, SnapshotSettings snapshotSettingsResource, CallSettings callSettings = null)

Patch snapshot settings.

Parameters
Name	Description
project	string Project ID for this request.
snapshotSettingsResource	SnapshotSettings The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
SnapshotSettingsServiceClient snapshotSettingsServiceClient = SnapshotSettingsServiceClient.Create();
// Initialize request argument(s)
string project = "";
SnapshotSettings snapshotSettingsResource = new SnapshotSettings();
// Make the request
lro::Operation<Operation, Operation> response = snapshotSettingsServiceClient.Patch(project, snapshotSettingsResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = snapshotSettingsServiceClient.PollOncePatch(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PatchAsync(PatchSnapshotSettingRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> PatchAsync(PatchSnapshotSettingRequest request, CallSettings callSettings = null)

Patch snapshot settings.

Parameters
Name	Description
request	PatchSnapshotSettingRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
SnapshotSettingsServiceClient snapshotSettingsServiceClient = await SnapshotSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
PatchSnapshotSettingRequest request = new PatchSnapshotSettingRequest
{
    RequestId = "",
    Project = "",
    SnapshotSettingsResource = new SnapshotSettings(),
    UpdateMask = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await snapshotSettingsServiceClient.PatchAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await snapshotSettingsServiceClient.PollOncePatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PatchAsync(PatchSnapshotSettingRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PatchAsync(PatchSnapshotSettingRequest request, CancellationToken cancellationToken)

Patch snapshot settings.

Parameters
Name	Description
request	PatchSnapshotSettingRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
SnapshotSettingsServiceClient snapshotSettingsServiceClient = await SnapshotSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
PatchSnapshotSettingRequest request = new PatchSnapshotSettingRequest
{
    RequestId = "",
    Project = "",
    SnapshotSettingsResource = new SnapshotSettings(),
    UpdateMask = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await snapshotSettingsServiceClient.PatchAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await snapshotSettingsServiceClient.PollOncePatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PatchAsync(string, SnapshotSettings, CallSettings)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, SnapshotSettings snapshotSettingsResource, CallSettings callSettings = null)

Patch snapshot settings.

Parameters
Name	Description
project	string Project ID for this request.
snapshotSettingsResource	SnapshotSettings The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
SnapshotSettingsServiceClient snapshotSettingsServiceClient = await SnapshotSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string project = "";
SnapshotSettings snapshotSettingsResource = new SnapshotSettings();
// Make the request
lro::Operation<Operation, Operation> response = await snapshotSettingsServiceClient.PatchAsync(project, snapshotSettingsResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await snapshotSettingsServiceClient.PollOncePatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PatchAsync(string, SnapshotSettings, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, SnapshotSettings snapshotSettingsResource, CancellationToken cancellationToken)

Patch snapshot settings.

Parameters
Name	Description
project	string Project ID for this request.
snapshotSettingsResource	SnapshotSettings The body resource for this request
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
SnapshotSettingsServiceClient snapshotSettingsServiceClient = await SnapshotSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string project = "";
SnapshotSettings snapshotSettingsResource = new SnapshotSettings();
// Make the request
lro::Operation<Operation, Operation> response = await snapshotSettingsServiceClient.PatchAsync(project, snapshotSettingsResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await snapshotSettingsServiceClient.PollOncePatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PollOncePatch(string, CallSettings)

public virtual Operation<Operation, Operation> PollOncePatch(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of Patch.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The result of polling the operation.

PollOncePatchAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOncePatchAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of Patch .

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.