Console
    Contact Us Start free

    Cloud Bigtable V2 Client - Class UpdateTableRequest (2.16.0)

    Reference documentation and code samples for the Cloud Bigtable V2 Client class UpdateTableRequest.

    The request for UpdateTable .

    Generated from protobuf message google.bigtable.admin.v2.UpdateTableRequest

    Namespace

    Google \ Cloud \ Bigtable \ Admin \ V2

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ table
    Table

    Required. The table to update. The table's name field is used to identify the table to update.

    ↳ update_mask
    Google\Protobuf\FieldMask

    Required. The list of fields to update. A mask specifying which fields (e.g. change_stream_config ) in the table field should be updated. This mask is relative to the table field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * * change_stream_config * * change_stream_config.retention_period * * deletion_protection * * row_key_schema If column_families is set in update_mask , it will return an UNIMPLEMENTED error.

    ↳ ignore_warnings
    bool

    Optional. If true, ignore safety checks when updating the table.

    getTable

    Required. The table to update.

    The table's name field is used to identify the table to update.

    Returns
    Type
    Description
    Table |null

    hasTable

    clearTable

    setTable

    Required. The table to update.

    The table's name field is used to identify the table to update.

    Parameter
    Name
    Description
    var
    Table
    Returns
    Type
    Description
    $this

    getUpdateMask

    Required. The list of fields to update.

    A mask specifying which fields (e.g. change_stream_config ) in the table field should be updated. This mask is relative to the table field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields:

    • change_stream_config
    • change_stream_config.retention_period
    • deletion_protection
    • row_key_schema If column_families is set in update_mask , it will return an UNIMPLEMENTED error.
    Returns
    Type
    Description
    Google\Protobuf\FieldMask |null

    hasUpdateMask

    clearUpdateMask

    setUpdateMask

    Required. The list of fields to update.

    A mask specifying which fields (e.g. change_stream_config ) in the table field should be updated. This mask is relative to the table field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields:

    • change_stream_config
    • change_stream_config.retention_period
    • deletion_protection
    • row_key_schema If column_families is set in update_mask , it will return an UNIMPLEMENTED error.
    Parameter
    Name
    Description
    var
    Google\Protobuf\FieldMask
    Returns
    Type
    Description
    $this

    getIgnoreWarnings

    Optional. If true, ignore safety checks when updating the table.

    Returns
    Type
    Description
    bool

    setIgnoreWarnings

    Optional. If true, ignore safety checks when updating the table.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    static::build

    Parameters
    Name
    Description
    table
    Table

    Required. The table to update. The table's name field is used to identify the table to update.

    updateMask
    Google\Protobuf\FieldMask

    Required. The list of fields to update. A mask specifying which fields (e.g. change_stream_config ) in the table field should be updated. This mask is relative to the table field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields:

      • change_stream_config
      • change_stream_config.retention_period
      • deletion_protection
      • row_key_schema

    If column_families is set in update_mask , it will return an UNIMPLEMENTED error.

    Returns
    Type
    Description
    UpdateTableRequest
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: