Interface DatabaseTableReferenceOrBuilder (0.21.0)

public interface DatabaseTableReferenceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getSchema()

public abstract Schema getSchema()

Optional. The schema of the table.

.google.cloud.geminidataanalytics.v1beta.Schema schema = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema

The schema.

getSchemaOrBuilder()

public abstract SchemaOrBuilder getSchemaOrBuilder()

Optional. The schema of the table.

.google.cloud.geminidataanalytics.v1beta.Schema schema = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SchemaOrBuilder

getTableId()

public abstract String getTableId()

Required. The name of the table as defined in the database.

Note: The precise rules for table naming, including valid characters, length limits, and case sensitivity, are determined by the specific database system.

Requirements:

  • Exact Match: The provided name must be identical to the name stored in the database.
  • Case Sensitivity: Respect the case sensitivity rules of the specific database system and how the table was created. For example, "Orders" and "orders" may be distinct table names.
  • Special Characters/Keywords: If the table name includes spaces, special characters, or is a database reserved keyword, provide the literal name as it is stored. Do not add any database-specific identifier quoting characters (e.g., ", `, []).

    Examples:

  • Simple name: "orders", "UserActivity"
  • Case sensitive: "MyTable"
  • Name with spaces: "Order Details"
  • Name with other special characters: "user/data", "order-items"
  • Name that is a keyword: "Group", "Order"

    Permissions: The caller's credentials must have the necessary database permissions to access the table's schema and data.

string table_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The tableId.

getTableIdBytes()

public abstract ByteString getTableIdBytes()

Required. The name of the table as defined in the database.

Note: The precise rules for table naming, including valid characters, length limits, and case sensitivity, are determined by the specific database system.

Requirements:

  • Exact Match: The provided name must be identical to the name stored in the database.
  • Case Sensitivity: Respect the case sensitivity rules of the specific database system and how the table was created. For example, "Orders" and "orders" may be distinct table names.
  • Special Characters/Keywords: If the table name includes spaces, special characters, or is a database reserved keyword, provide the literal name as it is stored. Do not add any database-specific identifier quoting characters (e.g., ", `, []).

    Examples:

  • Simple name: "orders", "UserActivity"
  • Case sensitive: "MyTable"
  • Name with spaces: "Order Details"
  • Name with other special characters: "user/data", "order-items"
  • Name that is a keyword: "Group", "Order"

    Permissions: The caller's credentials must have the necessary database permissions to access the table's schema and data.

string table_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for tableId.

hasSchema()

public abstract boolean hasSchema()

Optional. The schema of the table.

.google.cloud.geminidataanalytics.v1beta.Schema schema = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the schema field is set.