Show / Hide Table of Contents

Class TablesServiceClient

TablesService client wrapper, for convenient use.

Inheritance
System.Object
TablesServiceClient
TablesServiceClientImpl
Inherited Members
System.Object.ToString()
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Area120.Tables.V1Alpha1
Assembly: Google.Area120.Tables.V1Alpha1.dll
Syntax
public abstract class TablesServiceClient
Remarks

The Tables Service provides an API for reading and updating tables. It defines the following resource model:

  • The API has a collection of [Table][google.area120.tables.v1alpha1.Table] resources, named tables/*

  • Each Table has a collection of [Row][google.area120.tables.v1alpha1.Row] resources, named tables/*/rows/*

Properties

DefaultEndpoint

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

Declaration
public static string DefaultEndpoint { get; }
Property Value
Type Description
System.String

DefaultScopes

The default TablesService scopes.

Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyList<System.String>
Remarks

The default TablesService scopes are:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/spreadsheets
  • https://www.googleapis.com/auth/spreadsheets.readonly

GrpcClient

The underlying gRPC TablesService client

Declaration
public virtual TablesService.TablesServiceClient GrpcClient { get; }
Property Value
Type Description
TablesService.TablesServiceClient

Methods

BatchCreateRows(BatchCreateRowsRequest, CallSettings)

Creates multiple rows.

Declaration
public virtual BatchCreateRowsResponse BatchCreateRows(BatchCreateRowsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchCreateRowsRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchCreateRowsResponse

The RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
BatchCreateRowsRequest request = new BatchCreateRowsRequest
{
    Parent = "",
    Requests =
    {
        new CreateRowRequest(),
    },
};
// Make the request
BatchCreateRowsResponse response = tablesServiceClient.BatchCreateRows(request);

BatchCreateRowsAsync(BatchCreateRowsRequest, CallSettings)

Creates multiple rows.

Declaration
public virtual Task<BatchCreateRowsResponse> BatchCreateRowsAsync(BatchCreateRowsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchCreateRowsRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<BatchCreateRowsResponse>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateRowsRequest request = new BatchCreateRowsRequest
{
    Parent = "",
    Requests =
    {
        new CreateRowRequest(),
    },
};
// Make the request
BatchCreateRowsResponse response = await tablesServiceClient.BatchCreateRowsAsync(request);

BatchCreateRowsAsync(BatchCreateRowsRequest, CancellationToken)

Creates multiple rows.

Declaration
public virtual Task<BatchCreateRowsResponse> BatchCreateRowsAsync(BatchCreateRowsRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
BatchCreateRowsRequest request

The request object containing all of the parameters for the API call.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<BatchCreateRowsResponse>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateRowsRequest request = new BatchCreateRowsRequest
{
    Parent = "",
    Requests =
    {
        new CreateRowRequest(),
    },
};
// Make the request
BatchCreateRowsResponse response = await tablesServiceClient.BatchCreateRowsAsync(request);

BatchUpdateRows(BatchUpdateRowsRequest, CallSettings)

Updates multiple rows.

Declaration
public virtual BatchUpdateRowsResponse BatchUpdateRows(BatchUpdateRowsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchUpdateRowsRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchUpdateRowsResponse

The RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
BatchUpdateRowsRequest request = new BatchUpdateRowsRequest
{
    Parent = "",
    Requests =
    {
        new UpdateRowRequest(),
    },
};
// Make the request
BatchUpdateRowsResponse response = tablesServiceClient.BatchUpdateRows(request);

BatchUpdateRowsAsync(BatchUpdateRowsRequest, CallSettings)

Updates multiple rows.

Declaration
public virtual Task<BatchUpdateRowsResponse> BatchUpdateRowsAsync(BatchUpdateRowsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchUpdateRowsRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<BatchUpdateRowsResponse>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateRowsRequest request = new BatchUpdateRowsRequest
{
    Parent = "",
    Requests =
    {
        new UpdateRowRequest(),
    },
};
// Make the request
BatchUpdateRowsResponse response = await tablesServiceClient.BatchUpdateRowsAsync(request);

BatchUpdateRowsAsync(BatchUpdateRowsRequest, CancellationToken)

Updates multiple rows.

Declaration
public virtual Task<BatchUpdateRowsResponse> BatchUpdateRowsAsync(BatchUpdateRowsRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
BatchUpdateRowsRequest request

The request object containing all of the parameters for the API call.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<BatchUpdateRowsResponse>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateRowsRequest request = new BatchUpdateRowsRequest
{
    Parent = "",
    Requests =
    {
        new UpdateRowRequest(),
    },
};
// Make the request
BatchUpdateRowsResponse response = await tablesServiceClient.BatchUpdateRowsAsync(request);

Create()

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

Declaration
public static TablesServiceClient Create()
Returns
Type Description
TablesServiceClient

The created TablesServiceClient.

CreateAsync(CancellationToken)

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

Declaration
public static Task<TablesServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The System.Threading.CancellationToken to use while creating the client.

Returns
Type Description
System.Threading.Tasks.Task<TablesServiceClient>

The task representing the created TablesServiceClient.

CreateRow(CreateRowRequest, CallSettings)

Creates a row.

Declaration
public virtual Row CreateRow(CreateRowRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateRowRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Row

The RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
CreateRowRequest request = new CreateRowRequest
{
    Parent = "",
    Row = new Row(),
    View = View.Unspecified,
};
// Make the request
Row response = tablesServiceClient.CreateRow(request);

CreateRow(String, Row, CallSettings)

Creates a row.

Declaration
public virtual Row CreateRow(string parent, Row row, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. The parent table where this row will be created. Format: tables/{table}

Row row

Required. The row to create.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Row

The RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
string parent = "";
Row row = new Row();
// Make the request
Row response = tablesServiceClient.CreateRow(parent, row);

CreateRowAsync(CreateRowRequest, CallSettings)

Creates a row.

Declaration
public virtual Task<Row> CreateRowAsync(CreateRowRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateRowRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Row>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
CreateRowRequest request = new CreateRowRequest
{
    Parent = "",
    Row = new Row(),
    View = View.Unspecified,
};
// Make the request
Row response = await tablesServiceClient.CreateRowAsync(request);

CreateRowAsync(CreateRowRequest, CancellationToken)

Creates a row.

Declaration
public virtual Task<Row> CreateRowAsync(CreateRowRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreateRowRequest request

The request object containing all of the parameters for the API call.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Row>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
CreateRowRequest request = new CreateRowRequest
{
    Parent = "",
    Row = new Row(),
    View = View.Unspecified,
};
// Make the request
Row response = await tablesServiceClient.CreateRowAsync(request);

CreateRowAsync(String, Row, CallSettings)

Creates a row.

Declaration
public virtual Task<Row> CreateRowAsync(string parent, Row row, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. The parent table where this row will be created. Format: tables/{table}

Row row

Required. The row to create.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Row>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
Row row = new Row();
// Make the request
Row response = await tablesServiceClient.CreateRowAsync(parent, row);

CreateRowAsync(String, Row, CancellationToken)

Creates a row.

Declaration
public virtual Task<Row> CreateRowAsync(string parent, Row row, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String parent

Required. The parent table where this row will be created. Format: tables/{table}

Row row

Required. The row to create.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Row>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
Row row = new Row();
// Make the request
Row response = await tablesServiceClient.CreateRowAsync(parent, row);

DeleteRow(DeleteRowRequest, CallSettings)

Deletes a row.

Declaration
public virtual void DeleteRow(DeleteRowRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteRowRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
DeleteRowRequest request = new DeleteRowRequest
{
    RowName = RowName.FromTableRow("[TABLE]", "[ROW]"),
};
// Make the request
tablesServiceClient.DeleteRow(request);

DeleteRow(RowName, CallSettings)

Deletes a row.

Declaration
public virtual void DeleteRow(RowName name, CallSettings callSettings = null)
Parameters
Type Name Description
RowName name

Required. The name of the row to delete. Format: tables/{table}/rows/{row}

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
RowName name = RowName.FromTableRow("[TABLE]", "[ROW]");
// Make the request
tablesServiceClient.DeleteRow(name);

DeleteRow(String, CallSettings)

Deletes a row.

Declaration
public virtual void DeleteRow(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. The name of the row to delete. Format: tables/{table}/rows/{row}

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
string name = "tables/[TABLE]/rows/[ROW]";
// Make the request
tablesServiceClient.DeleteRow(name);

DeleteRowAsync(DeleteRowRequest, CallSettings)

Deletes a row.

Declaration
public virtual Task DeleteRowAsync(DeleteRowRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteRowRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteRowRequest request = new DeleteRowRequest
{
    RowName = RowName.FromTableRow("[TABLE]", "[ROW]"),
};
// Make the request
await tablesServiceClient.DeleteRowAsync(request);

DeleteRowAsync(DeleteRowRequest, CancellationToken)

Deletes a row.

Declaration
public virtual Task DeleteRowAsync(DeleteRowRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
DeleteRowRequest request

The request object containing all of the parameters for the API call.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteRowRequest request = new DeleteRowRequest
{
    RowName = RowName.FromTableRow("[TABLE]", "[ROW]"),
};
// Make the request
await tablesServiceClient.DeleteRowAsync(request);

DeleteRowAsync(RowName, CallSettings)

Deletes a row.

Declaration
public virtual Task DeleteRowAsync(RowName name, CallSettings callSettings = null)
Parameters
Type Name Description
RowName name

Required. The name of the row to delete. Format: tables/{table}/rows/{row}

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
RowName name = RowName.FromTableRow("[TABLE]", "[ROW]");
// Make the request
await tablesServiceClient.DeleteRowAsync(name);

DeleteRowAsync(RowName, CancellationToken)

Deletes a row.

Declaration
public virtual Task DeleteRowAsync(RowName name, CancellationToken cancellationToken)
Parameters
Type Name Description
RowName name

Required. The name of the row to delete. Format: tables/{table}/rows/{row}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
RowName name = RowName.FromTableRow("[TABLE]", "[ROW]");
// Make the request
await tablesServiceClient.DeleteRowAsync(name);

DeleteRowAsync(String, CallSettings)

Deletes a row.

Declaration
public virtual Task DeleteRowAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. The name of the row to delete. Format: tables/{table}/rows/{row}

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "tables/[TABLE]/rows/[ROW]";
// Make the request
await tablesServiceClient.DeleteRowAsync(name);

DeleteRowAsync(String, CancellationToken)

Deletes a row.

Declaration
public virtual Task DeleteRowAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. The name of the row to delete. Format: tables/{table}/rows/{row}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "tables/[TABLE]/rows/[ROW]";
// Make the request
await tablesServiceClient.DeleteRowAsync(name);

GetRow(GetRowRequest, CallSettings)

Gets a row. Returns NOT_FOUND if the row does not exist in the table.

Declaration
public virtual Row GetRow(GetRowRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetRowRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Row

The RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
GetRowRequest request = new GetRowRequest
{
    Name = "",
    View = View.Unspecified,
};
// Make the request
Row response = tablesServiceClient.GetRow(request);

GetRow(String, CallSettings)

Gets a row. Returns NOT_FOUND if the row does not exist in the table.

Declaration
public virtual Row GetRow(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. The name of the row to retrieve. Format: tables/{table}/rows/{row}

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Row

The RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
string name = "";
// Make the request
Row response = tablesServiceClient.GetRow(name);

GetRowAsync(GetRowRequest, CallSettings)

Gets a row. Returns NOT_FOUND if the row does not exist in the table.

Declaration
public virtual Task<Row> GetRowAsync(GetRowRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetRowRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Row>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
GetRowRequest request = new GetRowRequest
{
    Name = "",
    View = View.Unspecified,
};
// Make the request
Row response = await tablesServiceClient.GetRowAsync(request);

GetRowAsync(GetRowRequest, CancellationToken)

Gets a row. Returns NOT_FOUND if the row does not exist in the table.

Declaration
public virtual Task<Row> GetRowAsync(GetRowRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetRowRequest request

The request object containing all of the parameters for the API call.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Row>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
GetRowRequest request = new GetRowRequest
{
    Name = "",
    View = View.Unspecified,
};
// Make the request
Row response = await tablesServiceClient.GetRowAsync(request);

GetRowAsync(String, CallSettings)

Gets a row. Returns NOT_FOUND if the row does not exist in the table.

Declaration
public virtual Task<Row> GetRowAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. The name of the row to retrieve. Format: tables/{table}/rows/{row}

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Row>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
Row response = await tablesServiceClient.GetRowAsync(name);

GetRowAsync(String, CancellationToken)

Gets a row. Returns NOT_FOUND if the row does not exist in the table.

Declaration
public virtual Task<Row> GetRowAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. The name of the row to retrieve. Format: tables/{table}/rows/{row}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Row>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
Row response = await tablesServiceClient.GetRowAsync(name);

GetTable(GetTableRequest, CallSettings)

Gets a table. Returns NOT_FOUND if the table does not exist.

Declaration
public virtual Table GetTable(GetTableRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetTableRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Table

The RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
GetTableRequest request = new GetTableRequest { Name = "", };
// Make the request
Table response = tablesServiceClient.GetTable(request);

GetTable(String, CallSettings)

Gets a table. Returns NOT_FOUND if the table does not exist.

Declaration
public virtual Table GetTable(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. The name of the table to retrieve. Format: tables/{table}

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Table

The RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
string name = "";
// Make the request
Table response = tablesServiceClient.GetTable(name);

GetTableAsync(GetTableRequest, CallSettings)

Gets a table. Returns NOT_FOUND if the table does not exist.

Declaration
public virtual Task<Table> GetTableAsync(GetTableRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetTableRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Table>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
GetTableRequest request = new GetTableRequest { Name = "", };
// Make the request
Table response = await tablesServiceClient.GetTableAsync(request);

GetTableAsync(GetTableRequest, CancellationToken)

Gets a table. Returns NOT_FOUND if the table does not exist.

Declaration
public virtual Task<Table> GetTableAsync(GetTableRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetTableRequest request

The request object containing all of the parameters for the API call.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Table>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
GetTableRequest request = new GetTableRequest { Name = "", };
// Make the request
Table response = await tablesServiceClient.GetTableAsync(request);

GetTableAsync(String, CallSettings)

Gets a table. Returns NOT_FOUND if the table does not exist.

Declaration
public virtual Task<Table> GetTableAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. The name of the table to retrieve. Format: tables/{table}

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Table>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
Table response = await tablesServiceClient.GetTableAsync(name);

GetTableAsync(String, CancellationToken)

Gets a table. Returns NOT_FOUND if the table does not exist.

Declaration
public virtual Task<Table> GetTableAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. The name of the table to retrieve. Format: tables/{table}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Table>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
Table response = await tablesServiceClient.GetTableAsync(name);

ListRows(ListRowsRequest, CallSettings)

Lists rows in a table. Returns NOT_FOUND if the table does not exist.

Declaration
public virtual PagedEnumerable<ListRowsResponse, Row> ListRows(ListRowsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListRowsRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.Api.Gax.PagedEnumerable<ListRowsResponse, Row>

A pageable sequence of Row resources.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
ListRowsRequest request = new ListRowsRequest
{
    Parent = "",
    View = View.Unspecified,
};
// Make the request
PagedEnumerable<ListRowsResponse, Row> response = tablesServiceClient.ListRows(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Row item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRowsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Row item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Row> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Row item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRows(String, String, Nullable<Int32>, CallSettings)

Lists rows in a table. Returns NOT_FOUND if the table does not exist.

Declaration
public virtual PagedEnumerable<ListRowsResponse, Row> ListRows(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. The parent table. Format: tables/{table}

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.Api.Gax.PagedEnumerable<ListRowsResponse, Row>

A pageable sequence of Row resources.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
string parent = "";
// Make the request
PagedEnumerable<ListRowsResponse, Row> response = tablesServiceClient.ListRows(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Row item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListRowsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Row item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Row> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Row item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRowsAsync(ListRowsRequest, CallSettings)

Lists rows in a table. Returns NOT_FOUND if the table does not exist.

Declaration
public virtual PagedAsyncEnumerable<ListRowsResponse, Row> ListRowsAsync(ListRowsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListRowsRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.Api.Gax.PagedAsyncEnumerable<ListRowsResponse, Row>

A pageable asynchronous sequence of Row resources.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
ListRowsRequest request = new ListRowsRequest
{
    Parent = "",
    View = View.Unspecified,
};
// Make the request
PagedAsyncEnumerable<ListRowsResponse, Row> response = tablesServiceClient.ListRowsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Row item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRowsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Row item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Row> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Row item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListRowsAsync(String, String, Nullable<Int32>, CallSettings)

Lists rows in a table. Returns NOT_FOUND if the table does not exist.

Declaration
public virtual PagedAsyncEnumerable<ListRowsResponse, Row> ListRowsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. The parent table. Format: tables/{table}

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.Api.Gax.PagedAsyncEnumerable<ListRowsResponse, Row>

A pageable asynchronous sequence of Row resources.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
// Make the request
PagedAsyncEnumerable<ListRowsResponse, Row> response = tablesServiceClient.ListRowsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Row item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListRowsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Row item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Row> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Row item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTables(ListTablesRequest, CallSettings)

Lists tables for the user.

Declaration
public virtual PagedEnumerable<ListTablesResponse, Table> ListTables(ListTablesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListTablesRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.Api.Gax.PagedEnumerable<ListTablesResponse, Table>

A pageable sequence of Table resources.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
ListTablesRequest request = new ListTablesRequest { };
// Make the request
PagedEnumerable<ListTablesResponse, Table> response = tablesServiceClient.ListTables(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Table item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTablesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Table item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Table> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Table item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTablesAsync(ListTablesRequest, CallSettings)

Lists tables for the user.

Declaration
public virtual PagedAsyncEnumerable<ListTablesResponse, Table> ListTablesAsync(ListTablesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListTablesRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.Api.Gax.PagedAsyncEnumerable<ListTablesResponse, Table>

A pageable asynchronous sequence of Table resources.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
ListTablesRequest request = new ListTablesRequest { };
// Make the request
PagedAsyncEnumerable<ListTablesResponse, Table> response = tablesServiceClient.ListTablesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Table item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTablesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Table item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Table> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Table item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ShutdownDefaultChannelsAsync()

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

Declaration
public static Task ShutdownDefaultChannelsAsync()
Returns
Type Description
System.Threading.Tasks.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.

UpdateRow(Row, FieldMask, CallSettings)

Updates a row.

Declaration
public virtual Row UpdateRow(Row row, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
Row row

Required. The row to update.

Google.Protobuf.WellKnownTypes.FieldMask updateMask

The list of fields to update.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Row

The RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
Row row = new Row();
FieldMask updateMask = new FieldMask();
// Make the request
Row response = tablesServiceClient.UpdateRow(row, updateMask);

UpdateRow(UpdateRowRequest, CallSettings)

Updates a row.

Declaration
public virtual Row UpdateRow(UpdateRowRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateRowRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Row

The RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = TablesServiceClient.Create();
// Initialize request argument(s)
UpdateRowRequest request = new UpdateRowRequest
{
    Row = new Row(),
    UpdateMask = new FieldMask(),
    View = View.Unspecified,
};
// Make the request
Row response = tablesServiceClient.UpdateRow(request);

UpdateRowAsync(Row, FieldMask, CallSettings)

Updates a row.

Declaration
public virtual Task<Row> UpdateRowAsync(Row row, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
Row row

Required. The row to update.

Google.Protobuf.WellKnownTypes.FieldMask updateMask

The list of fields to update.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Row>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
Row row = new Row();
FieldMask updateMask = new FieldMask();
// Make the request
Row response = await tablesServiceClient.UpdateRowAsync(row, updateMask);

UpdateRowAsync(Row, FieldMask, CancellationToken)

Updates a row.

Declaration
public virtual Task<Row> UpdateRowAsync(Row row, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
Type Name Description
Row row

Required. The row to update.

Google.Protobuf.WellKnownTypes.FieldMask updateMask

The list of fields to update.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Row>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
Row row = new Row();
FieldMask updateMask = new FieldMask();
// Make the request
Row response = await tablesServiceClient.UpdateRowAsync(row, updateMask);

UpdateRowAsync(UpdateRowRequest, CallSettings)

Updates a row.

Declaration
public virtual Task<Row> UpdateRowAsync(UpdateRowRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateRowRequest request

The request object containing all of the parameters for the API call.

Google.Api.Gax.Grpc.CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Row>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateRowRequest request = new UpdateRowRequest
{
    Row = new Row(),
    UpdateMask = new FieldMask(),
    View = View.Unspecified,
};
// Make the request
Row response = await tablesServiceClient.UpdateRowAsync(request);

UpdateRowAsync(UpdateRowRequest, CancellationToken)

Updates a row.

Declaration
public virtual Task<Row> UpdateRowAsync(UpdateRowRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
UpdateRowRequest request

The request object containing all of the parameters for the API call.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Row>

A Task containing the RPC response.

Sample code
// Create client
TablesServiceClient tablesServiceClient = await TablesServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateRowRequest request = new UpdateRowRequest
{
    Row = new Row(),
    UpdateMask = new FieldMask(),
    View = View.Unspecified,
};
// Make the request
Row response = await tablesServiceClient.UpdateRowAsync(request);
Back to top