# Dataflow v1beta3 API - Class SnapshotsV1Beta3Client (2.0.0-beta10)

2.0.0-beta10 (latest) 2.0.0-beta09 1.0.0-beta03

    public abstract class SnapshotsV1Beta3Client

Reference documentation and code samples for the Dataflow v1beta3 API class SnapshotsV1Beta3Client.

SnapshotsV1Beta3 client wrapper, for convenient use.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> SnapshotsV1Beta3Client

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Derived Types

[SnapshotsV1Beta3ClientImpl](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3ClientImpl)

## Namespace

[Google.Cloud.Dataflow.V1Beta3](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3)

## Assembly

Google.Cloud.Dataflow.V1Beta3.dll

## Remarks

Provides methods to manage snapshots of Google Cloud Dataflow jobs.

## Properties

### DefaultEndpoint

    public static string DefaultEndpoint { get; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### DefaultScopes

    public static IReadOnlyList<string> DefaultScopes { get; }

The default SnapshotsV1Beta3 scopes.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1https://learn.microsoft.com/dotnet/api/system.string` |   |

**Remarks** The default SnapshotsV1Beta3 scopes are:

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

### GrpcClient

    public virtual SnapshotsV1Beta3.SnapshotsV1Beta3Client GrpcClient { get; }

The underlying gRPC SnapshotsV1Beta3 client

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3.SnapshotsV1Beta3Client` |   |

### ServiceMetadata

    public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.ServiceMetadata.html` |   |

## Methods

### Create()

    public static SnapshotsV1Beta3Client Create()

Synchronously creates a [SnapshotsV1Beta3Client](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3Client) using the default credentials, endpoint and
settings. To specify custom credentials or other settings, use [SnapshotsV1Beta3ClientBuilder](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3ClientBuilder).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3Client` | The created [SnapshotsV1Beta3Client](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3Client). |

### CreateAsync(CancellationToken)

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

Asynchronously creates a [SnapshotsV1Beta3Client](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3Client) using the default credentials, endpoint and
settings. To specify custom credentials or other settings, use [SnapshotsV1Beta3ClientBuilder](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3ClientBuilder).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken) to use while creating the client. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3Client` | The task representing the created [SnapshotsV1Beta3Client](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3Client). |

### DeleteSnapshot(DeleteSnapshotRequest, CallSettings)

    public virtual DeleteSnapshotResponse DeleteSnapshot(DeleteSnapshotRequest request, CallSettings callSettings = null)

Deletes a snapshot.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.DeleteSnapshotRequest` The request object containing all of the parameters for the API call. |
| `callSettings` | `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.CallSettings.html` If not null, applies overrides to this RPC call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.DeleteSnapshotResponse` | The RPC response. |

**Example**

    // Create client
    SnapshotsV1Beta3Client snapshotsV1Beta3Client = SnapshotsV1Beta3Client.Create();
    // Initialize request argument(s)
    DeleteSnapshotRequest request = new DeleteSnapshotRequest
    {
        ProjectId = "",
        SnapshotId = "",
        Location = "",
    };
    // Make the request
    DeleteSnapshotResponse response = snapshotsV1Beta3Client.DeleteSnapshot(request);

### DeleteSnapshotAsync(DeleteSnapshotRequest, CallSettings)

    public virtual Task<DeleteSnapshotResponse> DeleteSnapshotAsync(DeleteSnapshotRequest request, CallSettings callSettings = null)

Deletes a snapshot.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.DeleteSnapshotRequest` The request object containing all of the parameters for the API call. |
| `callSettings` | `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.CallSettings.html` If not null, applies overrides to this RPC call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.DeleteSnapshotResponse` | A Task containing the RPC response. |

**Example**

    // Create client
    SnapshotsV1Beta3Client snapshotsV1Beta3Client = await SnapshotsV1Beta3Client.CreateAsync();
    // Initialize request argument(s)
    DeleteSnapshotRequest request = new DeleteSnapshotRequest
    {
        ProjectId = "",
        SnapshotId = "",
        Location = "",
    };
    // Make the request
    DeleteSnapshotResponse response = await snapshotsV1Beta3Client.DeleteSnapshotAsync(request);

### DeleteSnapshotAsync(DeleteSnapshotRequest, CancellationToken)

    public virtual Task<DeleteSnapshotResponse> DeleteSnapshotAsync(DeleteSnapshotRequest request, CancellationToken cancellationToken)

Deletes a snapshot.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.DeleteSnapshotRequest` The request object containing all of the parameters for the API call. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` A [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken) to use for this RPC. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.DeleteSnapshotResponse` | A Task containing the RPC response. |

**Example**

    // Create client
    SnapshotsV1Beta3Client snapshotsV1Beta3Client = await SnapshotsV1Beta3Client.CreateAsync();
    // Initialize request argument(s)
    DeleteSnapshotRequest request = new DeleteSnapshotRequest
    {
        ProjectId = "",
        SnapshotId = "",
        Location = "",
    };
    // Make the request
    DeleteSnapshotResponse response = await snapshotsV1Beta3Client.DeleteSnapshotAsync(request);

### GetSnapshot(GetSnapshotRequest, CallSettings)

    public virtual Snapshot GetSnapshot(GetSnapshotRequest request, CallSettings callSettings = null)

Gets information about a snapshot.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.GetSnapshotRequest` The request object containing all of the parameters for the API call. |
| `callSettings` | `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.CallSettings.html` If not null, applies overrides to this RPC call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.Snapshot` | The RPC response. |

**Example**

    // Create client
    SnapshotsV1Beta3Client snapshotsV1Beta3Client = SnapshotsV1Beta3Client.Create();
    // Initialize request argument(s)
    GetSnapshotRequest request = new GetSnapshotRequest
    {
        ProjectId = "",
        SnapshotId = "",
        Location = "",
    };
    // Make the request
    Snapshot response = snapshotsV1Beta3Client.GetSnapshot(request);

### GetSnapshotAsync(GetSnapshotRequest, CallSettings)

    public virtual Task<Snapshot> GetSnapshotAsync(GetSnapshotRequest request, CallSettings callSettings = null)

Gets information about a snapshot.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.GetSnapshotRequest` The request object containing all of the parameters for the API call. |
| `callSettings` | `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.CallSettings.html` If not null, applies overrides to this RPC call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.Snapshot` | A Task containing the RPC response. |

**Example**

    // Create client
    SnapshotsV1Beta3Client snapshotsV1Beta3Client = await SnapshotsV1Beta3Client.CreateAsync();
    // Initialize request argument(s)
    GetSnapshotRequest request = new GetSnapshotRequest
    {
        ProjectId = "",
        SnapshotId = "",
        Location = "",
    };
    // Make the request
    Snapshot response = await snapshotsV1Beta3Client.GetSnapshotAsync(request);

### GetSnapshotAsync(GetSnapshotRequest, CancellationToken)

    public virtual Task<Snapshot> GetSnapshotAsync(GetSnapshotRequest request, CancellationToken cancellationToken)

Gets information about a snapshot.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.GetSnapshotRequest` The request object containing all of the parameters for the API call. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` A [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken) to use for this RPC. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.Snapshot` | A Task containing the RPC response. |

**Example**

    // Create client
    SnapshotsV1Beta3Client snapshotsV1Beta3Client = await SnapshotsV1Beta3Client.CreateAsync();
    // Initialize request argument(s)
    GetSnapshotRequest request = new GetSnapshotRequest
    {
        ProjectId = "",
        SnapshotId = "",
        Location = "",
    };
    // Make the request
    Snapshot response = await snapshotsV1Beta3Client.GetSnapshotAsync(request);

### ListSnapshots(ListSnapshotsRequest, CallSettings)

    public virtual ListSnapshotsResponse ListSnapshots(ListSnapshotsRequest request, CallSettings callSettings = null)

Lists snapshots.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.ListSnapshotsRequest` The request object containing all of the parameters for the API call. |
| `callSettings` | `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.CallSettings.html` If not null, applies overrides to this RPC call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.ListSnapshotsResponse` | The RPC response. |

**Example**

    // Create client
    SnapshotsV1Beta3Client snapshotsV1Beta3Client = SnapshotsV1Beta3Client.Create();
    // Initialize request argument(s)
    ListSnapshotsRequest request = new ListSnapshotsRequest
    {
        ProjectId = "",
        Location = "",
        JobId = "",
    };
    // Make the request
    ListSnapshotsResponse response = snapshotsV1Beta3Client.ListSnapshots(request);

### ListSnapshotsAsync(ListSnapshotsRequest, CallSettings)

    public virtual Task<ListSnapshotsResponse> ListSnapshotsAsync(ListSnapshotsRequest request, CallSettings callSettings = null)

Lists snapshots.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.ListSnapshotsRequest` The request object containing all of the parameters for the API call. |
| `callSettings` | `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.CallSettings.html` If not null, applies overrides to this RPC call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.ListSnapshotsResponse` | A Task containing the RPC response. |

**Example**

    // Create client
    SnapshotsV1Beta3Client snapshotsV1Beta3Client = await SnapshotsV1Beta3Client.CreateAsync();
    // Initialize request argument(s)
    ListSnapshotsRequest request = new ListSnapshotsRequest
    {
        ProjectId = "",
        Location = "",
        JobId = "",
    };
    // Make the request
    ListSnapshotsResponse response = await snapshotsV1Beta3Client.ListSnapshotsAsync(request);

### ListSnapshotsAsync(ListSnapshotsRequest, CancellationToken)

    public virtual Task<ListSnapshotsResponse> ListSnapshotsAsync(ListSnapshotsRequest request, CancellationToken cancellationToken)

Lists snapshots.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.ListSnapshotsRequest` The request object containing all of the parameters for the API call. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` A [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken) to use for this RPC. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.ListSnapshotsResponse` | A Task containing the RPC response. |

**Example**

    // Create client
    SnapshotsV1Beta3Client snapshotsV1Beta3Client = await SnapshotsV1Beta3Client.CreateAsync();
    // Initialize request argument(s)
    ListSnapshotsRequest request = new ListSnapshotsRequest
    {
        ProjectId = "",
        Location = "",
        JobId = "",
    };
    // Make the request
    ListSnapshotsResponse response = await snapshotsV1Beta3Client.ListSnapshotsAsync(request);

### ShutdownDefaultChannelsAsync()

    public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by [Create()](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3Client#Google_Cloud_Dataflow_V1Beta3_SnapshotsV1Beta3Client_Create) and
[CreateAsync(CancellationToken)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3Client#Google_Cloud_Dataflow_V1Beta3_SnapshotsV1Beta3Client_CreateAsync_System_Threading_CancellationToken_). Channels which weren't automatically created are not
affected.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task` | A task representing the asynchronous shutdown operation. |

**Remarks** After calling this method, further calls to [Create()](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3Client#Google_Cloud_Dataflow_V1Beta3_SnapshotsV1Beta3Client_Create) and
[CreateAsync(CancellationToken)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.SnapshotsV1Beta3Client#Google_Cloud_Dataflow_V1Beta3_SnapshotsV1Beta3Client_CreateAsync_System_Threading_CancellationToken_) will create new channels, which could in turn be shut down
by another call to this method.