Console
    Start free

    Google Cloud Chronicle V1 Client - Class DataTable (0.4.0)

    Reference documentation and code samples for the Google Cloud Chronicle V1 Client class DataTable.

    DataTable represents the data table resource.

    Generated from protobuf message google.cloud.chronicle.v1.DataTable

    Namespace

    Google \ Cloud \ Chronicle \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    Identifier. The resource name of the data table Format: "{project}/locations/{location}/instances/{instance}/dataTables/{data_table}"

    ↳ display_name
    string

    Output only. The unique display name of the data table.

    ↳ description
    string

    Required. A user-provided description of the data table.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. Table create time

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. Table update time

    ↳ column_info
    array< DataTableColumnInfo >

    Immutable. Details of all the columns in the table

    ↳ data_table_uuid
    string

    Output only. Data table unique id

    ↳ rules
    string[]

    Output only. The resource names for the associated Rules that use this data table. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}. {rule} here refers to the rule id.

    ↳ rule_associations_count
    int

    Output only. The count of rules using the data table.

    ↳ row_time_to_live
    string

    Optional. User-provided TTL of the data table.

    ↳ approximate_row_count
    int|string

    Output only. The count of rows in the data table.

    ↳ scope_info
    DataTableScopeInfo

    Optional. The scope info of the data table. During data table creation, if this field is not set, the data table without scopes (an unscoped table) will be created for a global user. For a scoped user, this field must be set. During data table update, if scope_info is requested to be updated, this field must be set.

    ↳ update_source
    int

    Output only. Source of the data table update.

    ↳ row_time_to_live_update_time
    Google\Protobuf\Timestamp

    Output only. Last update time of the TTL of the data table.

    getName

    Identifier. The resource name of the data table Format: "{project}/locations/{location}/instances/{instance}/dataTables/{data_table}"

    Returns
    Type
    Description
    string

    setName

    Identifier. The resource name of the data table Format: "{project}/locations/{location}/instances/{instance}/dataTables/{data_table}"

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    Output only. The unique display name of the data table.

    Returns
    Type
    Description
    string

    setDisplayName

    Output only. The unique display name of the data table.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    Required. A user-provided description of the data table.

    Returns
    Type
    Description
    string

    setDescription

    Required. A user-provided description of the data table.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. Table create time

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. Table create time

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. Table update time

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. Table update time

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getColumnInfo

    Immutable. Details of all the columns in the table

    Returns
    Type
    Description
    Google\Protobuf\RepeatedField < DataTableColumnInfo >

    setColumnInfo

    Immutable. Details of all the columns in the table

    Parameter
    Name
    Description
    var
    array< DataTableColumnInfo >
    Returns
    Type
    Description
    $this

    getDataTableUuid

    Output only. Data table unique id

    Returns
    Type
    Description
    string

    setDataTableUuid

    Output only. Data table unique id

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getRules

    Output only. The resource names for the associated Rules that use this data table. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}.

    {rule} here refers to the rule id.

    Returns
    Type
    Description
    Google\Protobuf\RepeatedField < string >

    setRules

    Output only. The resource names for the associated Rules that use this data table. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}.

    {rule} here refers to the rule id.

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getRuleAssociationsCount

    Output only. The count of rules using the data table.

    Returns
    Type
    Description
    int

    setRuleAssociationsCount

    Output only. The count of rules using the data table.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getRowTimeToLive

    Optional. User-provided TTL of the data table.

    Returns
    Type
    Description
    string

    setRowTimeToLive

    Optional. User-provided TTL of the data table.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getApproximateRowCount

    Output only. The count of rows in the data table.

    Returns
    Type
    Description
    int|string

    setApproximateRowCount

    Output only. The count of rows in the data table.

    Parameter
    Name
    Description
    var
    int|string
    Returns
    Type
    Description
    $this

    getScopeInfo

    Optional. The scope info of the data table.

    During data table creation, if this field is not set, the data table without scopes (an unscoped table) will be created for a global user. For a scoped user, this field must be set. During data table update, if scope_info is requested to be updated, this field must be set.

    Returns
    Type
    Description
    DataTableScopeInfo |null

    hasScopeInfo

    clearScopeInfo

    setScopeInfo

    Optional. The scope info of the data table.

    During data table creation, if this field is not set, the data table without scopes (an unscoped table) will be created for a global user. For a scoped user, this field must be set. During data table update, if scope_info is requested to be updated, this field must be set.

    Parameter
    Name
    Description
    var
    DataTableScopeInfo
    Returns
    Type
    Description
    $this

    getUpdateSource

    Output only. Source of the data table update.

    Returns
    Type
    Description
    int
    Enum of type DataTableUpdateSource .

    setUpdateSource

    Output only. Source of the data table update.

    Parameter
    Name
    Description
    var
    int

    Enum of type DataTableUpdateSource .

    Returns
    Type
    Description
    $this

    getRowTimeToLiveUpdateTime

    Output only. Last update time of the TTL of the data table.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasRowTimeToLiveUpdateTime

    clearRowTimeToLiveUpdateTime

    setRowTimeToLiveUpdateTime

    Output only. Last update time of the TTL of the data table.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: