api: google.golang.org/api/spanner/v1 Index | Files

package spanner

import "google.golang.org/api/spanner/v1"

Package spanner provides access to the Cloud Spanner API.

This package is DEPRECATED. Use package cloud.google.com/go/spanner instead.

For product documentation, see: https://cloud.google.com/spanner/

Creating a client

Usage example:

import "google.golang.org/api/spanner/v1"
...
ctx := context.Background()
spannerService, err := spanner.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:

spannerService, err := spanner.NewService(ctx, option.WithScopes(spanner.SpannerDataScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

spannerService, err := spanner.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
spannerService, err := spanner.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Package Files

spanner-gen.go

Constants

const (
    // View and manage your data across Google Cloud Platform services
    CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

    // Administer your Spanner databases
    SpannerAdminScope = "https://www.googleapis.com/auth/spanner.admin"

    // View and manage the contents of your Spanner databases
    SpannerDataScope = "https://www.googleapis.com/auth/spanner.data"
)

OAuth2 scopes used by this API.

type BeginTransactionRequest Uses

type BeginTransactionRequest struct {
    // Options: Required. Options for the new transaction.
    Options *TransactionOptions `json:"options,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Options") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Options") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

BeginTransactionRequest: The request for BeginTransaction.

func (*BeginTransactionRequest) MarshalJSON Uses

func (s *BeginTransactionRequest) MarshalJSON() ([]byte, error)

type Binding Uses

type Binding struct {
    // Condition: The condition that is associated with this binding.
    // NOTE: An unsatisfied condition will not allow user access via
    // current
    // binding. Different bindings, including their conditions, are
    // examined
    // independently.
    Condition *Expr `json:"condition,omitempty"`

    // Members: Specifies the identities requesting access for a Cloud
    // Platform resource.
    // `members` can have the following values:
    //
    // * `allUsers`: A special identifier that represents anyone who is
    //    on the internet; with or without a Google account.
    //
    // * `allAuthenticatedUsers`: A special identifier that represents
    // anyone
    //    who is authenticated with a Google account or a service
    // account.
    //
    // * `user:{emailid}`: An email address that represents a specific
    // Google
    //    account. For example, `alice@gmail.com` .
    //
    //
    // * `serviceAccount:{emailid}`: An email address that represents a
    // service
    //    account. For example,
    // `my-other-app@appspot.gserviceaccount.com`.
    //
    // * `group:{emailid}`: An email address that represents a Google
    // group.
    //    For example, `admins@example.com`.
    //
    //
    // * `domain:{domain}`: The G Suite domain (primary) that represents all
    // the
    //    users of that domain. For example, `google.com` or
    // `example.com`.
    //
    //
    Members []string `json:"members,omitempty"`

    // Role: Role that is assigned to `members`.
    // For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
    Role string `json:"role,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Condition") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Condition") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Binding: Associates `members` with a `role`.

func (*Binding) MarshalJSON Uses

func (s *Binding) MarshalJSON() ([]byte, error)
type ChildLink struct {
    // ChildIndex: The node to which the link points.
    ChildIndex int64 `json:"childIndex,omitempty"`

    // Type: The type of the link. For example, in Hash Joins this could be
    // used to
    // distinguish between the build child and the probe child, or in the
    // case
    // of the child being an output variable, to represent the tag
    // associated
    // with the output variable.
    Type string `json:"type,omitempty"`

    // Variable: Only present if the child node is SCALAR and corresponds
    // to an output variable of the parent node. The field carries the name
    // of
    // the output variable.
    // For example, a `TableScan` operator that reads rows from a table
    // will
    // have child links to the `SCALAR` nodes representing the output
    // variables
    // created for each column that is read by the operator. The
    // corresponding
    // `variable` fields will be set to the variable names assigned to
    // the
    // columns.
    Variable string `json:"variable,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ChildIndex") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ChildIndex") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ChildLink: Metadata associated with a parent-child relationship appearing in a PlanNode.

func (*ChildLink) MarshalJSON Uses

func (s *ChildLink) MarshalJSON() ([]byte, error)

type CommitRequest Uses

type CommitRequest struct {
    // Mutations: The mutations to be executed when this transaction
    // commits. All
    // mutations are applied atomically, in the order they appear in
    // this list.
    Mutations []*Mutation `json:"mutations,omitempty"`

    // SingleUseTransaction: Execute mutations in a temporary transaction.
    // Note that unlike
    // commit of a previously-started transaction, commit with a
    // temporary transaction is non-idempotent. That is, if
    // the
    // `CommitRequest` is sent to Cloud Spanner more than once
    // (for
    // instance, due to retries in the application, or in the
    // transport library), it is possible that the mutations are
    // executed more than once. If this is undesirable, use
    // BeginTransaction and
    // Commit instead.
    SingleUseTransaction *TransactionOptions `json:"singleUseTransaction,omitempty"`

    // TransactionId: Commit a previously-started transaction.
    TransactionId string `json:"transactionId,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Mutations") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Mutations") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CommitRequest: The request for Commit.

func (*CommitRequest) MarshalJSON Uses

func (s *CommitRequest) MarshalJSON() ([]byte, error)

type CommitResponse Uses

type CommitResponse struct {
    // CommitTimestamp: The Cloud Spanner timestamp at which the transaction
    // committed.
    CommitTimestamp string `json:"commitTimestamp,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CommitTimestamp") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CommitTimestamp") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

CommitResponse: The response for Commit.

func (*CommitResponse) MarshalJSON Uses

func (s *CommitResponse) MarshalJSON() ([]byte, error)

type CreateDatabaseMetadata Uses

type CreateDatabaseMetadata struct {
    // Database: The database being created.
    Database string `json:"database,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Database") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Database") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CreateDatabaseMetadata: Metadata type for the operation returned by CreateDatabase.

func (*CreateDatabaseMetadata) MarshalJSON Uses

func (s *CreateDatabaseMetadata) MarshalJSON() ([]byte, error)

type CreateDatabaseRequest Uses

type CreateDatabaseRequest struct {
    // CreateStatement: Required. A `CREATE DATABASE` statement, which
    // specifies the ID of the
    // new database.  The database ID must conform to the regular
    // expression
    // `a-z*[a-z0-9]` and be between 2 and 30 characters in length.
    // If the database ID is a reserved word or if it contains a hyphen,
    // the
    // database ID must be enclosed in backticks (`` ` ``).
    CreateStatement string `json:"createStatement,omitempty"`

    // ExtraStatements: An optional list of DDL statements to run inside the
    // newly created
    // database. Statements can create tables, indexes, etc.
    // These
    // statements execute atomically with the creation of the database:
    // if there is an error in any statement, the database is not created.
    ExtraStatements []string `json:"extraStatements,omitempty"`

    // ForceSendFields is a list of field names (e.g. "CreateStatement") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CreateStatement") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

CreateDatabaseRequest: The request for CreateDatabase.

func (*CreateDatabaseRequest) MarshalJSON Uses

func (s *CreateDatabaseRequest) MarshalJSON() ([]byte, error)

type CreateInstanceMetadata Uses

type CreateInstanceMetadata struct {
    // CancelTime: The time at which this operation was cancelled. If set,
    // this operation is
    // in the process of undoing itself (which is guaranteed to succeed)
    // and
    // cannot be cancelled again.
    CancelTime string `json:"cancelTime,omitempty"`

    // EndTime: The time at which this operation failed or was completed
    // successfully.
    EndTime string `json:"endTime,omitempty"`

    // Instance: The instance being created.
    Instance *Instance `json:"instance,omitempty"`

    // StartTime: The time at which the
    // CreateInstance request was
    // received.
    StartTime string `json:"startTime,omitempty"`

    // ForceSendFields is a list of field names (e.g. "CancelTime") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CancelTime") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CreateInstanceMetadata: Metadata type for the operation returned by CreateInstance.

func (*CreateInstanceMetadata) MarshalJSON Uses

func (s *CreateInstanceMetadata) MarshalJSON() ([]byte, error)

type CreateInstanceRequest Uses

type CreateInstanceRequest struct {
    // Instance: Required. The instance to create.  The name may be omitted,
    // but if
    // specified must be `<parent>/instances/<instance_id>`.
    Instance *Instance `json:"instance,omitempty"`

    // InstanceId: Required. The ID of the instance to create.  Valid
    // identifiers are of the
    // form `a-z*[a-z0-9]` and must be between 2 and 64 characters
    // in
    // length.
    InstanceId string `json:"instanceId,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Instance") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Instance") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CreateInstanceRequest: The request for CreateInstance.

func (*CreateInstanceRequest) MarshalJSON Uses

func (s *CreateInstanceRequest) MarshalJSON() ([]byte, error)

type CreateSessionRequest Uses

type CreateSessionRequest struct {
    // Session: The session to create.
    Session *Session `json:"session,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Session") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Session") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CreateSessionRequest: The request for CreateSession.

func (*CreateSessionRequest) MarshalJSON Uses

func (s *CreateSessionRequest) MarshalJSON() ([]byte, error)

type Database Uses

type Database struct {
    // Name: Required. The name of the database. Values are of the
    // form
    // `projects/<project>/instances/<instance>/databases/<database>`,
    // w
    // here `<database>` is as specified in the `CREATE DATABASE`
    // statement. This name can be passed to other API methods to
    // identify the database.
    Name string `json:"name,omitempty"`

    // State: Output only. The current database state.
    //
    // Possible values:
    //   "STATE_UNSPECIFIED" - Not specified.
    //   "CREATING" - The database is still being created. Operations on the
    // database may fail
    // with `FAILED_PRECONDITION` in this state.
    //   "READY" - The database is fully created and ready for use.
    State string `json:"state,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Name") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Name") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Database: A Cloud Spanner database.

func (*Database) MarshalJSON Uses

func (s *Database) MarshalJSON() ([]byte, error)

type Delete Uses

type Delete struct {
    // KeySet: Required. The primary keys of the rows within table to
    // delete.
    // Delete is idempotent. The transaction will succeed even if some or
    // all
    // rows do not exist.
    KeySet *KeySet `json:"keySet,omitempty"`

    // Table: Required. The table whose rows will be deleted.
    Table string `json:"table,omitempty"`

    // ForceSendFields is a list of field names (e.g. "KeySet") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "KeySet") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Delete: Arguments to delete operations.

func (*Delete) MarshalJSON Uses

func (s *Delete) MarshalJSON() ([]byte, error)

type Empty Uses

type Empty struct {
    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {
  rpc Bar(google.protobuf.Empty) returns

(google.protobuf.Empty);

}

The JSON representation for `Empty` is empty JSON object `{}`.

type ExecuteBatchDmlRequest Uses

type ExecuteBatchDmlRequest struct {
    // Seqno: A per-transaction sequence number used to identify this
    // request. This is
    // used in the same space as the seqno in
    // ExecuteSqlRequest. See more details
    // in ExecuteSqlRequest.
    Seqno int64 `json:"seqno,omitempty,string"`

    // Statements: The list of statements to execute in this batch.
    // Statements are executed
    // serially, such that the effects of statement i are visible to
    // statement
    // i+1. Each statement must be a DML statement. Execution will stop at
    // the
    // first failed statement; the remaining statements will not
    // run.
    //
    // REQUIRES: `statements_size()` > 0.
    Statements []*Statement `json:"statements,omitempty"`

    // Transaction: The transaction to use. A ReadWrite transaction is
    // required. Single-use
    // transactions are not supported (to avoid replay).  The caller must
    // either
    // supply an existing transaction ID or begin a new transaction.
    Transaction *TransactionSelector `json:"transaction,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Seqno") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Seqno") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ExecuteBatchDmlRequest: The request for ExecuteBatchDml

func (*ExecuteBatchDmlRequest) MarshalJSON Uses

func (s *ExecuteBatchDmlRequest) MarshalJSON() ([]byte, error)

type ExecuteBatchDmlResponse Uses

type ExecuteBatchDmlResponse struct {
    // ResultSets: ResultSets, one for each statement in the request that
    // ran successfully, in
    // the same order as the statements in the request. Each ResultSet
    // will
    // not contain any rows. The ResultSetStats in each ResultSet
    // will
    // contain the number of rows modified by the statement.
    //
    // Only the first ResultSet in the response contains a
    // valid
    // ResultSetMetadata.
    ResultSets []*ResultSet `json:"resultSets,omitempty"`

    // Status: If all DML statements are executed successfully, status will
    // be OK.
    // Otherwise, the error status of the first failed statement.
    Status *Status `json:"status,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "ResultSets") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ResultSets") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ExecuteBatchDmlResponse: The response for ExecuteBatchDml. Contains a list of ResultSet, one for each DML statement that has successfully executed. If a statement fails, the error is returned as part of the response payload. Clients can determine whether all DML statements have run successfully, or if a statement failed, using one of the following approaches:

1. Check if `'status'` field is `OkStatus`.
2. Check if `result_sets_size()` equals the number of statements

in

ExecuteBatchDmlRequest.

Example 1: A request with 5 DML statements, all executed successfully.

Result: A response with 5 ResultSets, one for each statement in the same order, and an `OkStatus`.

Example 2: A request with 5 DML statements. The 3rd statement has a syntax error.

Result: A response with 2 ResultSets, for the first 2 statements that run successfully, and a syntax error (`INVALID_ARGUMENT`) status. From `result_set_size()` client can determine that the 3rd statement has failed.

func (*ExecuteBatchDmlResponse) MarshalJSON Uses

func (s *ExecuteBatchDmlResponse) MarshalJSON() ([]byte, error)

type ExecuteSqlRequest Uses

type ExecuteSqlRequest struct {
    // ParamTypes: It is not always possible for Cloud Spanner to infer the
    // right SQL type
    // from a JSON value.  For example, values of type `BYTES` and values
    // of type `STRING` both appear in params as JSON strings.
    //
    // In these cases, `param_types` can be used to specify the exact
    // SQL type for some or all of the SQL statement parameters. See
    // the
    // definition of Type for more information
    // about SQL types.
    ParamTypes map[string]Type `json:"paramTypes,omitempty"`

    // Params: The SQL string can contain parameter placeholders. A
    // parameter
    // placeholder consists of `'@'` followed by the parameter
    // name. Parameter names consist of any combination of letters,
    // numbers, and underscores.
    //
    // Parameters can appear anywhere that a literal value is expected.  The
    // same
    // parameter name can be used more than once, for example:
    //   "WHERE id > @msg_id AND id < @msg_id + 100"
    //
    // It is an error to execute an SQL statement with unbound
    // parameters.
    //
    // Parameter values are specified using `params`, which is a JSON
    // object whose keys are parameter names, and whose values are
    // the
    // corresponding parameter values.
    Params googleapi.RawMessage `json:"params,omitempty"`

    // PartitionToken: If present, results will be restricted to the
    // specified partition
    // previously created using PartitionQuery().  There must be an
    // exact
    // match for the values of fields common to this message and
    // the
    // PartitionQueryRequest message used to create this partition_token.
    PartitionToken string `json:"partitionToken,omitempty"`

    // QueryMode: Used to control the amount of debugging information
    // returned in
    // ResultSetStats. If partition_token is set, query_mode can only
    // be set to QueryMode.NORMAL.
    //
    // Possible values:
    //   "NORMAL" - The default mode. Only the statement results are
    // returned.
    //   "PLAN" - This mode returns only the query plan, without any results
    // or
    // execution statistics information.
    //   "PROFILE" - This mode returns both the query plan and the execution
    // statistics along
    // with the results.
    QueryMode string `json:"queryMode,omitempty"`

    // ResumeToken: If this request is resuming a previously interrupted SQL
    // statement
    // execution, `resume_token` should be copied from the
    // last
    // PartialResultSet yielded before the interruption. Doing this
    // enables the new SQL statement execution to resume where the last one
    // left
    // off. The rest of the request parameters must exactly match
    // the
    // request that yielded this token.
    ResumeToken string `json:"resumeToken,omitempty"`

    // Seqno: A per-transaction sequence number used to identify this
    // request. This
    // makes each request idempotent such that if the request is received
    // multiple
    // times, at most one will succeed.
    //
    // The sequence number must be monotonically increasing within
    // the
    // transaction. If a request arrives for the first time with an
    // out-of-order
    // sequence number, the transaction may be aborted. Replays of
    // previously
    // handled requests will yield the same response as the first
    // execution.
    //
    // Required for DML statements. Ignored for queries.
    Seqno int64 `json:"seqno,omitempty,string"`

    // Sql: Required. The SQL string.
    Sql string `json:"sql,omitempty"`

    // Transaction: The transaction to use. If none is provided, the default
    // is a
    // temporary read-only transaction with strong concurrency.
    //
    // The transaction to use.
    //
    // For queries, if none is provided, the default is a temporary
    // read-only
    // transaction with strong concurrency.
    //
    // Standard DML statements require a ReadWrite transaction.
    // Single-use
    // transactions are not supported (to avoid replay).  The caller
    // must
    // either supply an existing transaction ID or begin a new
    // transaction.
    //
    // Partitioned DML requires an existing PartitionedDml transaction ID.
    Transaction *TransactionSelector `json:"transaction,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ParamTypes") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ParamTypes") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ExecuteSqlRequest: The request for ExecuteSql and ExecuteStreamingSql.

func (*ExecuteSqlRequest) MarshalJSON Uses

func (s *ExecuteSqlRequest) MarshalJSON() ([]byte, error)

type Expr Uses

type Expr struct {
    // Description: An optional description of the expression. This is a
    // longer text which
    // describes the expression, e.g. when hovered over it in a UI.
    Description string `json:"description,omitempty"`

    // Expression: Textual representation of an expression in
    // Common Expression Language syntax.
    //
    // The application context of the containing message determines
    // which
    // well-known feature set of CEL is supported.
    Expression string `json:"expression,omitempty"`

    // Location: An optional string indicating the location of the
    // expression for error
    // reporting, e.g. a file name and a position in the file.
    Location string `json:"location,omitempty"`

    // Title: An optional title for the expression, i.e. a short string
    // describing
    // its purpose. This can be used e.g. in UIs which allow to enter
    // the
    // expression.
    Title string `json:"title,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Description") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Description") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Expr: Represents an expression text. Example:

title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"

func (*Expr) MarshalJSON Uses

func (s *Expr) MarshalJSON() ([]byte, error)

type Field Uses

type Field struct {
    // Name: The name of the field. For reads, this is the column name.
    // For
    // SQL queries, it is the column alias (e.g., "Word" in the
    // query "SELECT 'hello' AS Word"), or the column name
    // (e.g.,
    // "ColName" in the query "SELECT ColName FROM Table"). Some
    // columns might have an empty name (e.g., !"SELECT
    // UPPER(ColName)"). Note that a query result can contain
    // multiple fields with the same name.
    Name string `json:"name,omitempty"`

    // Type: The type of the field.
    Type *Type `json:"type,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Name") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Name") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Field: Message representing a single field of a struct.

func (*Field) MarshalJSON Uses

func (s *Field) MarshalJSON() ([]byte, error)

type GetDatabaseDdlResponse Uses

type GetDatabaseDdlResponse struct {
    // Statements: A list of formatted DDL statements defining the schema of
    // the database
    // specified in the request.
    Statements []string `json:"statements,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Statements") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Statements") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GetDatabaseDdlResponse: The response for GetDatabaseDdl.

func (*GetDatabaseDdlResponse) MarshalJSON Uses

func (s *GetDatabaseDdlResponse) MarshalJSON() ([]byte, error)

type GetIamPolicyRequest Uses

type GetIamPolicyRequest struct {
}

GetIamPolicyRequest: Request message for `GetIamPolicy` method.

type Instance Uses

type Instance struct {
    // Config: Required. The name of the instance's configuration. Values
    // are of the form
    // `projects/<project>/instanceConfigs/<configuration>`. See
    // also InstanceConfig and
    // ListInstanceConfigs.
    Config string `json:"config,omitempty"`

    // DisplayName: Required. The descriptive name for this instance as it
    // appears in UIs.
    // Must be unique per project and between 4 and 30 characters in length.
    DisplayName string `json:"displayName,omitempty"`

    // Labels: Cloud Labels are a flexible and lightweight mechanism for
    // organizing cloud
    // resources into groups that reflect a customer's organizational needs
    // and
    // deployment strategies. Cloud Labels can be used to filter collections
    // of
    // resources. They can be used to control how resource metrics are
    // aggregated.
    // And they can be used as arguments to policy management rules (e.g.
    // route,
    // firewall, load balancing, etc.).
    //
    //  * Label keys must be between 1 and 63 characters long and must
    // conform to
    //    the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
    //  * Label values must be between 0 and 63 characters long and must
    // conform
    //    to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
    //  * No more than 64 labels can be associated with a given
    // resource.
    //
    // See https://goo.gl/xmQnxf for more information on and examples of
    // labels.
    //
    // If you plan to use labels in your own code, please note that
    // additional
    // characters may be allowed in the future. And so you are advised to
    // use an
    // internal label representation, such as JSON, which doesn't rely
    // upon
    // specific characters being disallowed.  For example, representing
    // labels
    // as the string:  name + "_" + value  would prove problematic if we
    // were to
    // allow "_" in a future release.
    Labels map[string]string `json:"labels,omitempty"`

    // Name: Required. A unique identifier for the instance, which cannot be
    // changed
    // after the instance is created. Values are of the
    // form
    // `projects/<project>/instances/a-z*[a-z0-9]`. The final
    // segment of the name must be between 2 and 64 characters in length.
    Name string `json:"name,omitempty"`

    // NodeCount: Required. The number of nodes allocated to this instance.
    // This may be zero
    // in API responses for instances that are not yet in state
    // `READY`.
    //
    // See
    // [the
    // documentation](https://cloud.google.com/spanner/docs/instances#no
    // de_count)
    // for more information about nodes.
    NodeCount int64 `json:"nodeCount,omitempty"`

    // State: Output only. The current instance state. For
    // CreateInstance, the state must be
    // either omitted or set to `CREATING`. For
    // UpdateInstance, the state must be
    // either omitted or set to `READY`.
    //
    // Possible values:
    //   "STATE_UNSPECIFIED" - Not specified.
    //   "CREATING" - The instance is still being created. Resources may not
    // be
    // available yet, and operations such as database creation may not
    // work.
    //   "READY" - The instance is fully created and ready to do work such
    // as
    // creating databases.
    State string `json:"state,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Config") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Config") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Instance: An isolated set of Cloud Spanner resources on which databases can be hosted.

func (*Instance) MarshalJSON Uses

func (s *Instance) MarshalJSON() ([]byte, error)

type InstanceConfig Uses

type InstanceConfig struct {
    // DisplayName: The name of this instance configuration as it appears in
    // UIs.
    DisplayName string `json:"displayName,omitempty"`

    // Name: A unique identifier for the instance configuration.  Values
    // are of the form
    // `projects/<project>/instanceConfigs/a-z*`
    Name string `json:"name,omitempty"`

    // Replicas: The geographic placement of nodes in this instance
    // configuration and their
    // replication properties.
    Replicas []*ReplicaInfo `json:"replicas,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "DisplayName") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "DisplayName") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

InstanceConfig: A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.

func (*InstanceConfig) MarshalJSON Uses

func (s *InstanceConfig) MarshalJSON() ([]byte, error)

type KeyRange Uses

type KeyRange struct {
    // EndClosed: If the end is closed, then the range includes all rows
    // whose
    // first `len(end_closed)` key columns exactly match `end_closed`.
    EndClosed []interface{} `json:"endClosed,omitempty"`

    // EndOpen: If the end is open, then the range excludes rows whose
    // first
    // `len(end_open)` key columns exactly match `end_open`.
    EndOpen []interface{} `json:"endOpen,omitempty"`

    // StartClosed: If the start is closed, then the range includes all rows
    // whose
    // first `len(start_closed)` key columns exactly match `start_closed`.
    StartClosed []interface{} `json:"startClosed,omitempty"`

    // StartOpen: If the start is open, then the range excludes rows whose
    // first
    // `len(start_open)` key columns exactly match `start_open`.
    StartOpen []interface{} `json:"startOpen,omitempty"`

    // ForceSendFields is a list of field names (e.g. "EndClosed") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "EndClosed") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

KeyRange: KeyRange represents a range of rows in a table or index.

A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key.

Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described here.

For example, consider the following table definition:

CREATE TABLE UserEvents (
  UserName STRING(MAX),
  EventDate STRING(10)
) PRIMARY KEY(UserName, EventDate);

The following keys name rows in this table:

"Bob", "2014-09-23"

Since the `UserEvents` table's `PRIMARY KEY` clause names two columns, each `UserEvents` key has two elements; the first is the `UserName`, and the second is the `EventDate`.

Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user "Bob" that occurred in the year 2015:

"start_closed": ["Bob", "2015-01-01"]
"end_closed": ["Bob", "2015-12-31"]

Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included.

For example, the following range includes all events for "Bob" that occurred during and after the year 2000:

"start_closed": ["Bob", "2000-01-01"]
"end_closed": ["Bob"]

The next example retrieves all events for "Bob":

"start_closed": ["Bob"]
"end_closed": ["Bob"]

To retrieve events before the year 2000:

"start_closed": ["Bob"]
"end_open": ["Bob", "2000-01-01"]

The following range includes all rows in the table:

"start_closed": []
"end_closed": []

This range returns all users whose `UserName` begins with any character from A to C:

"start_closed": ["A"]
"end_open": ["D"]

This range returns all users whose `UserName` begins with B:

"start_closed": ["B"]
"end_open": ["C"]

Key ranges honor column sort order. For example, suppose a table is defined as follows:

CREATE TABLE DescendingSortedTable {
  Key INT64,
  ...
) PRIMARY KEY(Key DESC);

The following range retrieves all rows with key values between 1 and 100 inclusive:

"start_closed": ["100"]
"end_closed": ["1"]

Note that 100 is passed as the start, and 1 is passed as the end, because `Key` is a descending column in the schema.

func (*KeyRange) MarshalJSON Uses

func (s *KeyRange) MarshalJSON() ([]byte, error)

type KeySet Uses

type KeySet struct {
    // All: For convenience `all` can be set to `true` to indicate that
    // this
    // `KeySet` matches all keys in the table or index. Note that any
    // keys
    // specified in `keys` or `ranges` are only yielded once.
    All bool `json:"all,omitempty"`

    // Keys: A list of specific keys. Entries in `keys` should have exactly
    // as
    // many elements as there are columns in the primary or index key
    // with which this `KeySet` is used.  Individual key values are
    // encoded as described here.
    Keys [][]interface{} `json:"keys,omitempty"`

    // Ranges: A list of key ranges. See KeyRange for more information
    // about
    // key range specifications.
    Ranges []*KeyRange `json:"ranges,omitempty"`

    // ForceSendFields is a list of field names (e.g. "All") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "All") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

KeySet: `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All the keys are expected to be in the same table or index. The keys need not be sorted in any particular way.

If the same key is specified multiple times in the set (for example if two ranges, two keys, or a key and a range overlap), Cloud Spanner behaves as if the key were only specified once.

func (*KeySet) MarshalJSON Uses

func (s *KeySet) MarshalJSON() ([]byte, error)

type ListDatabasesResponse Uses

type ListDatabasesResponse struct {
    // Databases: Databases that matched the request.
    Databases []*Database `json:"databases,omitempty"`

    // NextPageToken: `next_page_token` can be sent in a
    // subsequent
    // ListDatabases call to fetch more
    // of the matching databases.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Databases") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Databases") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListDatabasesResponse: The response for ListDatabases.

func (*ListDatabasesResponse) MarshalJSON Uses

func (s *ListDatabasesResponse) MarshalJSON() ([]byte, error)

type ListInstanceConfigsResponse Uses

type ListInstanceConfigsResponse struct {
    // InstanceConfigs: The list of requested instance configurations.
    InstanceConfigs []*InstanceConfig `json:"instanceConfigs,omitempty"`

    // NextPageToken: `next_page_token` can be sent in a
    // subsequent
    // ListInstanceConfigs call to
    // fetch more of the matching instance configurations.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "InstanceConfigs") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "InstanceConfigs") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

ListInstanceConfigsResponse: The response for ListInstanceConfigs.

func (*ListInstanceConfigsResponse) MarshalJSON Uses

func (s *ListInstanceConfigsResponse) MarshalJSON() ([]byte, error)

type ListInstancesResponse Uses

type ListInstancesResponse struct {
    // Instances: The list of requested instances.
    Instances []*Instance `json:"instances,omitempty"`

    // NextPageToken: `next_page_token` can be sent in a
    // subsequent
    // ListInstances call to fetch more
    // of the matching instances.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Instances") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Instances") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListInstancesResponse: The response for ListInstances.

func (*ListInstancesResponse) MarshalJSON Uses

func (s *ListInstancesResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse Uses

type ListOperationsResponse struct {
    // NextPageToken: The standard List next-page token.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // Operations: A list of operations that matches the specified filter in
    // the request.
    Operations []*Operation `json:"operations,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "NextPageToken") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (*ListOperationsResponse) MarshalJSON Uses

func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListSessionsResponse Uses

type ListSessionsResponse struct {
    // NextPageToken: `next_page_token` can be sent in a
    // subsequent
    // ListSessions call to fetch more of the matching
    // sessions.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // Sessions: The list of requested sessions.
    Sessions []*Session `json:"sessions,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "NextPageToken") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListSessionsResponse: The response for ListSessions.

func (*ListSessionsResponse) MarshalJSON Uses

func (s *ListSessionsResponse) MarshalJSON() ([]byte, error)

type Mutation Uses

type Mutation struct {
    // Delete: Delete rows from a table. Succeeds whether or not the
    // named
    // rows were present.
    Delete *Delete `json:"delete,omitempty"`

    // Insert: Insert new rows in a table. If any of the rows already
    // exist,
    // the write or transaction fails with error `ALREADY_EXISTS`.
    Insert *Write `json:"insert,omitempty"`

    // InsertOrUpdate: Like insert, except that if the row already exists,
    // then
    // its column values are overwritten with the ones provided. Any
    // column values not explicitly written are preserved.
    InsertOrUpdate *Write `json:"insertOrUpdate,omitempty"`

    // Replace: Like insert, except that if the row already exists, it
    // is
    // deleted, and the column values provided are inserted
    // instead. Unlike insert_or_update, this means any values
    // not
    // explicitly written become `NULL`.
    Replace *Write `json:"replace,omitempty"`

    // Update: Update existing rows in a table. If any of the rows does
    // not
    // already exist, the transaction fails with error `NOT_FOUND`.
    Update *Write `json:"update,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Delete") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Delete") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Mutation: A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call.

func (*Mutation) MarshalJSON Uses

func (s *Mutation) MarshalJSON() ([]byte, error)

type Operation Uses

type Operation struct {
    // Done: If the value is `false`, it means the operation is still in
    // progress.
    // If `true`, the operation is completed, and either `error` or
    // `response` is
    // available.
    Done bool `json:"done,omitempty"`

    // Error: The error result of the operation in case of failure or
    // cancellation.
    Error *Status `json:"error,omitempty"`

    // Metadata: Service-specific metadata associated with the operation.
    // It typically
    // contains progress information and common metadata such as create
    // time.
    // Some services might not provide such metadata.  Any method that
    // returns a
    // long-running operation should document the metadata type, if any.
    Metadata googleapi.RawMessage `json:"metadata,omitempty"`

    // Name: The server-assigned name, which is only unique within the same
    // service that
    // originally returns it. If you use the default HTTP mapping,
    // the
    // `name` should be a resource name ending with
    // `operations/{unique_id}`.
    Name string `json:"name,omitempty"`

    // Response: The normal response of the operation in case of success.
    // If the original
    // method returns no data on success, such as `Delete`, the response
    // is
    // `google.protobuf.Empty`.  If the original method is
    // standard
    // `Get`/`Create`/`Update`, the response should be the resource.  For
    // other
    // methods, the response should have the type `XxxResponse`, where
    // `Xxx`
    // is the original method name.  For example, if the original method
    // name
    // is `TakeSnapshot()`, the inferred response type
    // is
    // `TakeSnapshotResponse`.
    Response googleapi.RawMessage `json:"response,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Done") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Done") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (*Operation) MarshalJSON Uses

func (s *Operation) MarshalJSON() ([]byte, error)

type PartialResultSet Uses

type PartialResultSet struct {
    // ChunkedValue: If true, then the final value in values is chunked, and
    // must
    // be combined with more values from subsequent `PartialResultSet`s
    // to obtain a complete field value.
    ChunkedValue bool `json:"chunkedValue,omitempty"`

    // Metadata: Metadata about the result set, such as row type
    // information.
    // Only present in the first response.
    Metadata *ResultSetMetadata `json:"metadata,omitempty"`

    // ResumeToken: Streaming calls might be interrupted for a variety of
    // reasons, such
    // as TCP connection loss. If this occurs, the stream of results can
    // be resumed by re-sending the original request and
    // including
    // `resume_token`. Note that executing any other transaction in the
    // same session invalidates the token.
    ResumeToken string `json:"resumeToken,omitempty"`

    // Stats: Query plan and execution statistics for the statement that
    // produced this
    // streaming result set. These can be requested by
    // setting
    // ExecuteSqlRequest.query_mode and are sent
    // only once with the last response in the stream.
    // This field will also be present in the last response for
    // DML
    // statements.
    Stats *ResultSetStats `json:"stats,omitempty"`

    // Values: A streamed result set consists of a stream of values, which
    // might
    // be split into many `PartialResultSet` messages to accommodate
    // large rows and/or large values. Every N complete values defines
    // a
    // row, where N is equal to the number of entries
    // in
    // metadata.row_type.fields.
    //
    // Most values are encoded based on type as described
    // here.
    //
    // It is possible that the last value in values is "chunked",
    // meaning that the rest of the value is sent in
    // subsequent
    // `PartialResultSet`(s). This is denoted by the chunked_value
    // field. Two or more chunked values can be merged to form a
    // complete value as follows:
    //
    //   * `bool/number/null`: cannot be chunked
    //   * `string`: concatenate the strings
    //   * `list`: concatenate the lists. If the last element in a list is
    // a
    //     `string`, `list`, or `object`, merge it with the first element
    // in
    //     the next list by applying these rules recursively.
    //   * `object`: concatenate the (field name, field value) pairs. If a
    //     field name is duplicated, then apply these rules recursively
    //     to merge the field values.
    //
    // Some examples of merging:
    //
    //     # Strings are concatenated.
    //     "foo", "bar" => "foobar"
    //
    //     # Lists of non-strings are concatenated.
    //     [2, 3], [4] => [2, 3, 4]
    //
    //     # Lists are concatenated, but the last and first elements are
    // merged
    //     # because they are strings.
    //     ["a", "b"], ["c", "d"] => ["a", "bc", "d"]
    //
    //     # Lists are concatenated, but the last and first elements are
    // merged
    //     # because they are lists. Recursively, the last and first
    // elements
    //     # of the inner lists are merged because they are strings.
    //     ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]
    //
    //     # Non-overlapping object fields are combined.
    //     {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}
    //
    //     # Overlapping object fields are merged.
    //     {"a": "1"}, {"a": "2"} => {"a": "12"}
    //
    //     # Examples of merging objects containing lists of strings.
    //     {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}
    //
    // For a more complete example, suppose a streaming SQL query
    // is
    // yielding a result set whose rows contain a single string
    // field. The following `PartialResultSet`s might be yielded:
    //
    //     {
    //       "metadata": { ... }
    //       "values": ["Hello", "W"]
    //       "chunked_value": true
    //       "resume_token": "Af65..."
    //     }
    //     {
    //       "values": ["orl"]
    //       "chunked_value": true
    //       "resume_token": "Bqp2..."
    //     }
    //     {
    //       "values": ["d"]
    //       "resume_token": "Zx1B..."
    //     }
    //
    // This sequence of `PartialResultSet`s encodes two rows, one
    // containing the field value "Hello", and a second containing
    // the
    // field value "World" = "W" + "orl" + "d".
    Values []interface{} `json:"values,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "ChunkedValue") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ChunkedValue") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

PartialResultSet: Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume.

func (*PartialResultSet) MarshalJSON Uses

func (s *PartialResultSet) MarshalJSON() ([]byte, error)

type Partition Uses

type Partition struct {
    // PartitionToken: This token can be passed to Read, StreamingRead,
    // ExecuteSql, or
    // ExecuteStreamingSql requests to restrict the results to those
    // identified by
    // this partition token.
    PartitionToken string `json:"partitionToken,omitempty"`

    // ForceSendFields is a list of field names (e.g. "PartitionToken") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "PartitionToken") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

Partition: Information returned for each partition returned in a PartitionResponse.

func (*Partition) MarshalJSON Uses

func (s *Partition) MarshalJSON() ([]byte, error)

type PartitionOptions Uses

type PartitionOptions struct {
    // MaxPartitions: **Note:** This hint is currently ignored by
    // PartitionQuery and
    // PartitionRead requests.
    //
    // The desired maximum number of partitions to return.  For example,
    // this may
    // be set to the number of workers available.  The default for this
    // option
    // is currently 10,000. The maximum value is currently 200,000.  This is
    // only
    // a hint.  The actual number of partitions returned may be smaller or
    // larger
    // than this maximum count request.
    MaxPartitions int64 `json:"maxPartitions,omitempty,string"`

    // PartitionSizeBytes: **Note:** This hint is currently ignored by
    // PartitionQuery and
    // PartitionRead requests.
    //
    // The desired data size for each partition generated.  The default for
    // this
    // option is currently 1 GiB.  This is only a hint. The actual size of
    // each
    // partition may be smaller or larger than this size request.
    PartitionSizeBytes int64 `json:"partitionSizeBytes,omitempty,string"`

    // ForceSendFields is a list of field names (e.g. "MaxPartitions") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "MaxPartitions") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

PartitionOptions: Options for a PartitionQueryRequest and PartitionReadRequest.

func (*PartitionOptions) MarshalJSON Uses

func (s *PartitionOptions) MarshalJSON() ([]byte, error)

type PartitionQueryRequest Uses

type PartitionQueryRequest struct {
    // ParamTypes: It is not always possible for Cloud Spanner to infer the
    // right SQL type
    // from a JSON value.  For example, values of type `BYTES` and values
    // of type `STRING` both appear in params as JSON strings.
    //
    // In these cases, `param_types` can be used to specify the exact
    // SQL type for some or all of the SQL query parameters. See
    // the
    // definition of Type for more information
    // about SQL types.
    ParamTypes map[string]Type `json:"paramTypes,omitempty"`

    // Params: The SQL query string can contain parameter placeholders. A
    // parameter
    // placeholder consists of `'@'` followed by the parameter
    // name. Parameter names consist of any combination of letters,
    // numbers, and underscores.
    //
    // Parameters can appear anywhere that a literal value is expected.  The
    // same
    // parameter name can be used more than once, for example:
    //   "WHERE id > @msg_id AND id < @msg_id + 100"
    //
    // It is an error to execute an SQL query with unbound
    // parameters.
    //
    // Parameter values are specified using `params`, which is a JSON
    // object whose keys are parameter names, and whose values are
    // the
    // corresponding parameter values.
    Params googleapi.RawMessage `json:"params,omitempty"`

    // PartitionOptions: Additional options that affect how many partitions
    // are created.
    PartitionOptions *PartitionOptions `json:"partitionOptions,omitempty"`

    // Sql: The query request to generate partitions for. The request will
    // fail if
    // the query is not root partitionable. The query plan of a
    // root
    // partitionable query has a single distributed union operator. A
    // distributed
    // union operator conceptually divides one or more tables into
    // multiple
    // splits, remotely evaluates a subquery independently on each split,
    // and
    // then unions all results.
    //
    // This must not contain DML commands, such as INSERT, UPDATE,
    // or
    // DELETE. Use ExecuteStreamingSql with a
    // PartitionedDml transaction for large, partition-friendly DML
    // operations.
    Sql string `json:"sql,omitempty"`

    // Transaction: Read only snapshot transactions are supported,
    // read/write and single use
    // transactions are not.
    Transaction *TransactionSelector `json:"transaction,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ParamTypes") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ParamTypes") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

PartitionQueryRequest: The request for PartitionQuery

func (*PartitionQueryRequest) MarshalJSON Uses

func (s *PartitionQueryRequest) MarshalJSON() ([]byte, error)

type PartitionReadRequest Uses

type PartitionReadRequest struct {
    // Columns: The columns of table to be returned for each row
    // matching
    // this request.
    Columns []string `json:"columns,omitempty"`

    // Index: If non-empty, the name of an index on table. This index
    // is
    // used instead of the table primary key when interpreting key_set
    // and sorting result rows. See key_set for further information.
    Index string `json:"index,omitempty"`

    // KeySet: Required. `key_set` identifies the rows to be yielded.
    // `key_set` names the
    // primary keys of the rows in table to be yielded, unless index
    // is present. If index is present, then key_set instead names
    // index keys in index.
    //
    // It is not an error for the `key_set` to name rows that do not
    // exist in the database. Read yields nothing for nonexistent rows.
    KeySet *KeySet `json:"keySet,omitempty"`

    // PartitionOptions: Additional options that affect how many partitions
    // are created.
    PartitionOptions *PartitionOptions `json:"partitionOptions,omitempty"`

    // Table: Required. The name of the table in the database to be read.
    Table string `json:"table,omitempty"`

    // Transaction: Read only snapshot transactions are supported,
    // read/write and single use
    // transactions are not.
    Transaction *TransactionSelector `json:"transaction,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Columns") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Columns") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

PartitionReadRequest: The request for PartitionRead

func (*PartitionReadRequest) MarshalJSON Uses

func (s *PartitionReadRequest) MarshalJSON() ([]byte, error)

type PartitionResponse Uses

type PartitionResponse struct {
    // Partitions: Partitions created by this request.
    Partitions []*Partition `json:"partitions,omitempty"`

    // Transaction: Transaction created by this request.
    Transaction *Transaction `json:"transaction,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Partitions") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Partitions") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

PartitionResponse: The response for PartitionQuery or PartitionRead

func (*PartitionResponse) MarshalJSON Uses

func (s *PartitionResponse) MarshalJSON() ([]byte, error)

type PartitionedDml Uses

type PartitionedDml struct {
}

PartitionedDml: Message type to initiate a Partitioned DML transaction.

type PlanNode Uses

type PlanNode struct {
    // ChildLinks: List of child node `index`es and their relationship to
    // this parent.
    ChildLinks []*ChildLink `json:"childLinks,omitempty"`

    // DisplayName: The display name for the node.
    DisplayName string `json:"displayName,omitempty"`

    // ExecutionStats: The execution statistics associated with the node,
    // contained in a group of
    // key-value pairs. Only present if the plan was returned as a result of
    // a
    // profile query. For example, number of executions, number of rows/time
    // per
    // execution etc.
    ExecutionStats googleapi.RawMessage `json:"executionStats,omitempty"`

    // Index: The `PlanNode`'s index in node list.
    Index int64 `json:"index,omitempty"`

    // Kind: Used to determine the type of node. May be needed for
    // visualizing
    // different kinds of nodes differently. For example, If the node is
    // a
    // SCALAR node, it will have a condensed representation
    // which can be used to directly embed a description of the node in
    // its
    // parent.
    //
    // Possible values:
    //   "KIND_UNSPECIFIED" - Not specified.
    //   "RELATIONAL" - Denotes a Relational operator node in the expression
    // tree. Relational
    // operators represent iterative processing of rows during query
    // execution.
    // For example, a `TableScan` operation that reads rows from a table.
    //   "SCALAR" - Denotes a Scalar node in the expression tree. Scalar
    // nodes represent
    // non-iterable entities in the query plan. For example, constants
    // or
    // arithmetic operators appearing inside predicate expressions or
    // references
    // to column names.
    Kind string `json:"kind,omitempty"`

    // Metadata: Attributes relevant to the node contained in a group of
    // key-value pairs.
    // For example, a Parameter Reference node could have the
    // following
    // information in its metadata:
    //
    //     {
    //       "parameter_reference": "param1",
    //       "parameter_type": "array"
    //     }
    Metadata googleapi.RawMessage `json:"metadata,omitempty"`

    // ShortRepresentation: Condensed representation for SCALAR nodes.
    ShortRepresentation *ShortRepresentation `json:"shortRepresentation,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ChildLinks") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ChildLinks") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

PlanNode: Node information for nodes appearing in a QueryPlan.plan_nodes.

func (*PlanNode) MarshalJSON Uses

func (s *PlanNode) MarshalJSON() ([]byte, error)

type Policy Uses

type Policy struct {
    // Bindings: Associates a list of `members` to a `role`.
    // `bindings` with no members will result in an error.
    Bindings []*Binding `json:"bindings,omitempty"`

    // Etag: `etag` is used for optimistic concurrency control as a way to
    // help
    // prevent simultaneous updates of a policy from overwriting each
    // other.
    // It is strongly suggested that systems make use of the `etag` in
    // the
    // read-modify-write cycle to perform policy updates in order to avoid
    // race
    // conditions: An `etag` is returned in the response to `getIamPolicy`,
    // and
    // systems are expected to put that etag in the request to
    // `setIamPolicy` to
    // ensure that their change will be applied to the same version of the
    // policy.
    //
    // If no `etag` is provided in the call to `setIamPolicy`, then the
    // existing
    // policy is overwritten blindly.
    Etag string `json:"etag,omitempty"`

    // Version: Deprecated.
    Version int64 `json:"version,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Bindings") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Bindings") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Policy: Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.

A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.

**JSON Example**

{
  "bindings": [
    {
      "role": "roles/owner",
      "members": [
        "user:mike@example.com",
        "group:admins@example.com",
        "domain:google.com",

"serviceAccount:my-other-app@appspot.gserviceaccount.com"

      ]
    },
    {
      "role": "roles/viewer",
      "members": ["user:sean@example.com"]
    }
  ]
}

**YAML Example**

bindings:
- members:
  - user:mike@example.com
  - group:admins@example.com
  - domain:google.com
  - serviceAccount:my-other-app@appspot.gserviceaccount.com
  role: roles/owner
- members:
  - user:sean@example.com
  role: roles/viewer

For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).

func (*Policy) MarshalJSON Uses

func (s *Policy) MarshalJSON() ([]byte, error)

type ProjectsInstanceConfigsGetCall Uses

type ProjectsInstanceConfigsGetCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstanceConfigsGetCall) Context Uses

func (c *ProjectsInstanceConfigsGetCall) Context(ctx context.Context) *ProjectsInstanceConfigsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsGetCall) Do Uses

func (c *ProjectsInstanceConfigsGetCall) Do(opts ...googleapi.CallOption) (*InstanceConfig, error)

Do executes the "spanner.projects.instanceConfigs.get" call. Exactly one of *InstanceConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *InstanceConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstanceConfigsGetCall) Fields Uses

func (c *ProjectsInstanceConfigsGetCall) Fields(s ...googleapi.Field) *ProjectsInstanceConfigsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstanceConfigsGetCall) Header Uses

func (c *ProjectsInstanceConfigsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsInstanceConfigsGetCall) IfNoneMatch Uses

func (c *ProjectsInstanceConfigsGetCall) IfNoneMatch(entityTag string) *ProjectsInstanceConfigsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstanceConfigsListCall Uses

type ProjectsInstanceConfigsListCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstanceConfigsListCall) Context Uses

func (c *ProjectsInstanceConfigsListCall) Context(ctx context.Context) *ProjectsInstanceConfigsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsListCall) Do Uses

func (c *ProjectsInstanceConfigsListCall) Do(opts ...googleapi.CallOption) (*ListInstanceConfigsResponse, error)

Do executes the "spanner.projects.instanceConfigs.list" call. Exactly one of *ListInstanceConfigsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListInstanceConfigsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstanceConfigsListCall) Fields Uses

func (c *ProjectsInstanceConfigsListCall) Fields(s ...googleapi.Field) *ProjectsInstanceConfigsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstanceConfigsListCall) Header Uses

func (c *ProjectsInstanceConfigsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsInstanceConfigsListCall) IfNoneMatch Uses

func (c *ProjectsInstanceConfigsListCall) IfNoneMatch(entityTag string) *ProjectsInstanceConfigsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstanceConfigsListCall) PageSize Uses

func (c *ProjectsInstanceConfigsListCall) PageSize(pageSize int64) *ProjectsInstanceConfigsListCall

PageSize sets the optional parameter "pageSize": Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

func (*ProjectsInstanceConfigsListCall) PageToken Uses

func (c *ProjectsInstanceConfigsListCall) PageToken(pageToken string) *ProjectsInstanceConfigsListCall

PageToken sets the optional parameter "pageToken": If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigsResponse.

func (*ProjectsInstanceConfigsListCall) Pages Uses

func (c *ProjectsInstanceConfigsListCall) Pages(ctx context.Context, f func(*ListInstanceConfigsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsInstanceConfigsService Uses

type ProjectsInstanceConfigsService struct {
    // contains filtered or unexported fields
}

func NewProjectsInstanceConfigsService Uses

func NewProjectsInstanceConfigsService(s *Service) *ProjectsInstanceConfigsService

func (*ProjectsInstanceConfigsService) Get Uses

func (r *ProjectsInstanceConfigsService) Get(name string) *ProjectsInstanceConfigsGetCall

Get: Gets information about a particular instance configuration.

func (*ProjectsInstanceConfigsService) List Uses

func (r *ProjectsInstanceConfigsService) List(parent string) *ProjectsInstanceConfigsListCall

List: Lists the supported instance configurations for a given project.

type ProjectsInstancesCreateCall Uses

type ProjectsInstancesCreateCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesCreateCall) Context Uses

func (c *ProjectsInstancesCreateCall) Context(ctx context.Context) *ProjectsInstancesCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesCreateCall) Do Uses

func (c *ProjectsInstancesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "spanner.projects.instances.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesCreateCall) Fields Uses

func (c *ProjectsInstancesCreateCall) Fields(s ...googleapi.Field) *ProjectsInstancesCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesCreateCall) Header Uses

func (c *ProjectsInstancesCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesCreateCall Uses

type ProjectsInstancesDatabasesCreateCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesCreateCall) Context Uses

func (c *ProjectsInstancesDatabasesCreateCall) Context(ctx context.Context) *ProjectsInstancesDatabasesCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesCreateCall) Do Uses

func (c *ProjectsInstancesDatabasesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "spanner.projects.instances.databases.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesCreateCall) Fields Uses

func (c *ProjectsInstancesDatabasesCreateCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesCreateCall) Header Uses

func (c *ProjectsInstancesDatabasesCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesDropDatabaseCall Uses

type ProjectsInstancesDatabasesDropDatabaseCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesDropDatabaseCall) Context Uses

func (c *ProjectsInstancesDatabasesDropDatabaseCall) Context(ctx context.Context) *ProjectsInstancesDatabasesDropDatabaseCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesDropDatabaseCall) Do Uses

func (c *ProjectsInstancesDatabasesDropDatabaseCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "spanner.projects.instances.databases.dropDatabase" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesDropDatabaseCall) Fields Uses

func (c *ProjectsInstancesDatabasesDropDatabaseCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesDropDatabaseCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesDropDatabaseCall) Header Uses

func (c *ProjectsInstancesDatabasesDropDatabaseCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesGetCall Uses

type ProjectsInstancesDatabasesGetCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesGetCall) Context Uses

func (c *ProjectsInstancesDatabasesGetCall) Context(ctx context.Context) *ProjectsInstancesDatabasesGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesGetCall) Do Uses

func (c *ProjectsInstancesDatabasesGetCall) Do(opts ...googleapi.CallOption) (*Database, error)

Do executes the "spanner.projects.instances.databases.get" call. Exactly one of *Database or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Database.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesGetCall) Fields Uses

func (c *ProjectsInstancesDatabasesGetCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesGetCall) Header Uses

func (c *ProjectsInstancesDatabasesGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsInstancesDatabasesGetCall) IfNoneMatch Uses

func (c *ProjectsInstancesDatabasesGetCall) IfNoneMatch(entityTag string) *ProjectsInstancesDatabasesGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesDatabasesGetDdlCall Uses

type ProjectsInstancesDatabasesGetDdlCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesGetDdlCall) Context Uses

func (c *ProjectsInstancesDatabasesGetDdlCall) Context(ctx context.Context) *ProjectsInstancesDatabasesGetDdlCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesGetDdlCall) Do Uses

func (c *ProjectsInstancesDatabasesGetDdlCall) Do(opts ...googleapi.CallOption) (*GetDatabaseDdlResponse, error)

Do executes the "spanner.projects.instances.databases.getDdl" call. Exactly one of *GetDatabaseDdlResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GetDatabaseDdlResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesGetDdlCall) Fields Uses

func (c *ProjectsInstancesDatabasesGetDdlCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesGetDdlCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesGetDdlCall) Header Uses

func (c *ProjectsInstancesDatabasesGetDdlCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsInstancesDatabasesGetDdlCall) IfNoneMatch Uses

func (c *ProjectsInstancesDatabasesGetDdlCall) IfNoneMatch(entityTag string) *ProjectsInstancesDatabasesGetDdlCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesDatabasesGetIamPolicyCall Uses

type ProjectsInstancesDatabasesGetIamPolicyCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesGetIamPolicyCall) Context Uses

func (c *ProjectsInstancesDatabasesGetIamPolicyCall) Context(ctx context.Context) *ProjectsInstancesDatabasesGetIamPolicyCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesGetIamPolicyCall) Do Uses

func (c *ProjectsInstancesDatabasesGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "spanner.projects.instances.databases.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesGetIamPolicyCall) Fields Uses

func (c *ProjectsInstancesDatabasesGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesGetIamPolicyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesGetIamPolicyCall) Header Uses

func (c *ProjectsInstancesDatabasesGetIamPolicyCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesListCall Uses

type ProjectsInstancesDatabasesListCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesListCall) Context Uses

func (c *ProjectsInstancesDatabasesListCall) Context(ctx context.Context) *ProjectsInstancesDatabasesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesListCall) Do Uses

func (c *ProjectsInstancesDatabasesListCall) Do(opts ...googleapi.CallOption) (*ListDatabasesResponse, error)

Do executes the "spanner.projects.instances.databases.list" call. Exactly one of *ListDatabasesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListDatabasesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesListCall) Fields Uses

func (c *ProjectsInstancesDatabasesListCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesListCall) Header Uses

func (c *ProjectsInstancesDatabasesListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsInstancesDatabasesListCall) IfNoneMatch Uses

func (c *ProjectsInstancesDatabasesListCall) IfNoneMatch(entityTag string) *ProjectsInstancesDatabasesListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesDatabasesListCall) PageSize Uses

func (c *ProjectsInstancesDatabasesListCall) PageSize(pageSize int64) *ProjectsInstancesDatabasesListCall

PageSize sets the optional parameter "pageSize": Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

func (*ProjectsInstancesDatabasesListCall) PageToken Uses

func (c *ProjectsInstancesDatabasesListCall) PageToken(pageToken string) *ProjectsInstancesDatabasesListCall

PageToken sets the optional parameter "pageToken": If non-empty, `page_token` should contain a next_page_token from a previous ListDatabasesResponse.

func (*ProjectsInstancesDatabasesListCall) Pages Uses

func (c *ProjectsInstancesDatabasesListCall) Pages(ctx context.Context, f func(*ListDatabasesResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsInstancesDatabasesOperationsCancelCall Uses

type ProjectsInstancesDatabasesOperationsCancelCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesOperationsCancelCall) Context Uses

func (c *ProjectsInstancesDatabasesOperationsCancelCall) Context(ctx context.Context) *ProjectsInstancesDatabasesOperationsCancelCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesOperationsCancelCall) Do Uses

func (c *ProjectsInstancesDatabasesOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "spanner.projects.instances.databases.operations.cancel" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesOperationsCancelCall) Fields Uses

func (c *ProjectsInstancesDatabasesOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesOperationsCancelCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesOperationsCancelCall) Header Uses

func (c *ProjectsInstancesDatabasesOperationsCancelCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesOperationsDeleteCall Uses

type ProjectsInstancesDatabasesOperationsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesOperationsDeleteCall) Context Uses

func (c *ProjectsInstancesDatabasesOperationsDeleteCall) Context(ctx context.Context) *ProjectsInstancesDatabasesOperationsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesOperationsDeleteCall) Do Uses

func (c *ProjectsInstancesDatabasesOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "spanner.projects.instances.databases.operations.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesOperationsDeleteCall) Fields Uses

func (c *ProjectsInstancesDatabasesOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesOperationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesOperationsDeleteCall) Header Uses

func (c *ProjectsInstancesDatabasesOperationsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesOperationsGetCall Uses

type ProjectsInstancesDatabasesOperationsGetCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesOperationsGetCall) Context Uses

func (c *ProjectsInstancesDatabasesOperationsGetCall) Context(ctx context.Context) *ProjectsInstancesDatabasesOperationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesOperationsGetCall) Do Uses

func (c *ProjectsInstancesDatabasesOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "spanner.projects.instances.databases.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesOperationsGetCall) Fields Uses

func (c *ProjectsInstancesDatabasesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesOperationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesOperationsGetCall) Header Uses

func (c *ProjectsInstancesDatabasesOperationsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsInstancesDatabasesOperationsGetCall) IfNoneMatch Uses

func (c *ProjectsInstancesDatabasesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsInstancesDatabasesOperationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesDatabasesOperationsListCall Uses

type ProjectsInstancesDatabasesOperationsListCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesOperationsListCall) Context Uses

func (c *ProjectsInstancesDatabasesOperationsListCall) Context(ctx context.Context) *ProjectsInstancesDatabasesOperationsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesOperationsListCall) Do Uses

func (c *ProjectsInstancesDatabasesOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)

Do executes the "spanner.projects.instances.databases.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesOperationsListCall) Fields Uses

func (c *ProjectsInstancesDatabasesOperationsListCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesOperationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesOperationsListCall) Filter Uses

func (c *ProjectsInstancesDatabasesOperationsListCall) Filter(filter string) *ProjectsInstancesDatabasesOperationsListCall

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsInstancesDatabasesOperationsListCall) Header Uses

func (c *ProjectsInstancesDatabasesOperationsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsInstancesDatabasesOperationsListCall) IfNoneMatch Uses

func (c *ProjectsInstancesDatabasesOperationsListCall) IfNoneMatch(entityTag string) *ProjectsInstancesDatabasesOperationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesDatabasesOperationsListCall) PageSize Uses

func (c *ProjectsInstancesDatabasesOperationsListCall) PageSize(pageSize int64) *ProjectsInstancesDatabasesOperationsListCall

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsInstancesDatabasesOperationsListCall) PageToken Uses

func (c *ProjectsInstancesDatabasesOperationsListCall) PageToken(pageToken string) *ProjectsInstancesDatabasesOperationsListCall

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsInstancesDatabasesOperationsListCall) Pages Uses

func (c *ProjectsInstancesDatabasesOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsInstancesDatabasesOperationsService Uses

type ProjectsInstancesDatabasesOperationsService struct {
    // contains filtered or unexported fields
}

func NewProjectsInstancesDatabasesOperationsService Uses

func NewProjectsInstancesDatabasesOperationsService(s *Service) *ProjectsInstancesDatabasesOperationsService

func (*ProjectsInstancesDatabasesOperationsService) Cancel Uses

func (r *ProjectsInstancesDatabasesOperationsService) Cancel(name string) *ProjectsInstancesDatabasesOperationsCancelCall

Cancel: Starts asynchronous cancellation on a long-running operation.

The server

makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

func (*ProjectsInstancesDatabasesOperationsService) Delete Uses

func (r *ProjectsInstancesDatabasesOperationsService) Delete(name string) *ProjectsInstancesDatabasesOperationsDeleteCall

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

func (*ProjectsInstancesDatabasesOperationsService) Get Uses

func (r *ProjectsInstancesDatabasesOperationsService) Get(name string) *ProjectsInstancesDatabasesOperationsGetCall

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

func (*ProjectsInstancesDatabasesOperationsService) List Uses

func (r *ProjectsInstancesDatabasesOperationsService) List(name string) *ProjectsInstancesDatabasesOperationsListCall

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

type ProjectsInstancesDatabasesService Uses

type ProjectsInstancesDatabasesService struct {
    Operations *ProjectsInstancesDatabasesOperationsService

    Sessions *ProjectsInstancesDatabasesSessionsService
    // contains filtered or unexported fields
}

func NewProjectsInstancesDatabasesService Uses

func NewProjectsInstancesDatabasesService(s *Service) *ProjectsInstancesDatabasesService

func (*ProjectsInstancesDatabasesService) Create Uses

func (r *ProjectsInstancesDatabasesService) Create(parent string, createdatabaserequest *CreateDatabaseRequest) *ProjectsInstancesDatabasesCreateCall

Create: Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.

func (*ProjectsInstancesDatabasesService) DropDatabase Uses

func (r *ProjectsInstancesDatabasesService) DropDatabase(database string) *ProjectsInstancesDatabasesDropDatabaseCall

DropDatabase: Drops (aka deletes) a Cloud Spanner database.

func (*ProjectsInstancesDatabasesService) Get Uses

func (r *ProjectsInstancesDatabasesService) Get(name string) *ProjectsInstancesDatabasesGetCall

Get: Gets the state of a Cloud Spanner database.

func (*ProjectsInstancesDatabasesService) GetDdl Uses

func (r *ProjectsInstancesDatabasesService) GetDdl(database string) *ProjectsInstancesDatabasesGetDdlCall

GetDdl: Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations API.

func (*ProjectsInstancesDatabasesService) GetIamPolicy Uses

func (r *ProjectsInstancesDatabasesService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *ProjectsInstancesDatabasesGetIamPolicyCall

GetIamPolicy: Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set.

Authorization requires `spanner.databases.getIamPolicy` permission on resource.

func (*ProjectsInstancesDatabasesService) List Uses

func (r *ProjectsInstancesDatabasesService) List(parent string) *ProjectsInstancesDatabasesListCall

List: Lists Cloud Spanner databases.

func (*ProjectsInstancesDatabasesService) SetIamPolicy Uses

func (r *ProjectsInstancesDatabasesService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsInstancesDatabasesSetIamPolicyCall

SetIamPolicy: Sets the access control policy on a database resource. Replaces any existing policy.

Authorization requires `spanner.databases.setIamPolicy` permission on resource.

func (*ProjectsInstancesDatabasesService) TestIamPermissions Uses

func (r *ProjectsInstancesDatabasesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsInstancesDatabasesTestIamPermissionsCall

TestIamPermissions: Returns permissions that the caller has on the specified database resource.

Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions.

func (*ProjectsInstancesDatabasesService) UpdateDdl Uses

func (r *ProjectsInstancesDatabasesService) UpdateDdl(database string, updatedatabaseddlrequest *UpdateDatabaseDdlRequest) *ProjectsInstancesDatabasesUpdateDdlCall

UpdateDdl: Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.

type ProjectsInstancesDatabasesSessionsBeginTransactionCall Uses

type ProjectsInstancesDatabasesSessionsBeginTransactionCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsBeginTransactionCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsBeginTransactionCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsBeginTransactionCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsBeginTransactionCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsBeginTransactionCall) Do(opts ...googleapi.CallOption) (*Transaction, error)

Do executes the "spanner.projects.instances.databases.sessions.beginTransaction" call. Exactly one of *Transaction or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Transaction.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsBeginTransactionCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsBeginTransactionCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsBeginTransactionCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsBeginTransactionCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsBeginTransactionCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesSessionsCommitCall Uses

type ProjectsInstancesDatabasesSessionsCommitCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsCommitCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsCommitCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsCommitCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsCommitCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsCommitCall) Do(opts ...googleapi.CallOption) (*CommitResponse, error)

Do executes the "spanner.projects.instances.databases.sessions.commit" call. Exactly one of *CommitResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CommitResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsCommitCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsCommitCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsCommitCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsCommitCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsCommitCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesSessionsCreateCall Uses

type ProjectsInstancesDatabasesSessionsCreateCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsCreateCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsCreateCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsCreateCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsCreateCall) Do(opts ...googleapi.CallOption) (*Session, error)

Do executes the "spanner.projects.instances.databases.sessions.create" call. Exactly one of *Session or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Session.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsCreateCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsCreateCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsCreateCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesSessionsDeleteCall Uses

type ProjectsInstancesDatabasesSessionsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsDeleteCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsDeleteCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsDeleteCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "spanner.projects.instances.databases.sessions.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsDeleteCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsDeleteCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsDeleteCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall Uses

type ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall) Do(opts ...googleapi.CallOption) (*ExecuteBatchDmlResponse, error)

Do executes the "spanner.projects.instances.databases.sessions.executeBatchDml" call. Exactly one of *ExecuteBatchDmlResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ExecuteBatchDmlResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesSessionsExecuteSqlCall Uses

type ProjectsInstancesDatabasesSessionsExecuteSqlCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsExecuteSqlCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsExecuteSqlCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsExecuteSqlCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsExecuteSqlCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsExecuteSqlCall) Do(opts ...googleapi.CallOption) (*ResultSet, error)

Do executes the "spanner.projects.instances.databases.sessions.executeSql" call. Exactly one of *ResultSet or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ResultSet.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsExecuteSqlCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsExecuteSqlCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsExecuteSqlCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsExecuteSqlCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsExecuteSqlCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall Uses

type ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall) Do(opts ...googleapi.CallOption) (*PartialResultSet, error)

Do executes the "spanner.projects.instances.databases.sessions.executeStreamingSql" call. Exactly one of *PartialResultSet or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PartialResultSet.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesSessionsGetCall Uses

type ProjectsInstancesDatabasesSessionsGetCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsGetCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsGetCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsGetCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsGetCall) Do(opts ...googleapi.CallOption) (*Session, error)

Do executes the "spanner.projects.instances.databases.sessions.get" call. Exactly one of *Session or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Session.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsGetCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsGetCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsGetCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsInstancesDatabasesSessionsGetCall) IfNoneMatch Uses

func (c *ProjectsInstancesDatabasesSessionsGetCall) IfNoneMatch(entityTag string) *ProjectsInstancesDatabasesSessionsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesDatabasesSessionsListCall Uses

type ProjectsInstancesDatabasesSessionsListCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsListCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsListCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsListCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsListCall) Do(opts ...googleapi.CallOption) (*ListSessionsResponse, error)

Do executes the "spanner.projects.instances.databases.sessions.list" call. Exactly one of *ListSessionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListSessionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsListCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsListCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsListCall) Filter Uses

func (c *ProjectsInstancesDatabasesSessionsListCall) Filter(filter string) *ProjectsInstancesDatabasesSessionsListCall

Filter sets the optional parameter "filter": An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

* `labels.key` where key is the name of a label

Some examples of using filters are:

* `labels.env:*` --> The session has the label "env".
* `labels.env:dev` --> The session has the label "env" and the

value of

the label contains the string "dev".

func (*ProjectsInstancesDatabasesSessionsListCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsInstancesDatabasesSessionsListCall) IfNoneMatch Uses

func (c *ProjectsInstancesDatabasesSessionsListCall) IfNoneMatch(entityTag string) *ProjectsInstancesDatabasesSessionsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesDatabasesSessionsListCall) PageSize Uses

func (c *ProjectsInstancesDatabasesSessionsListCall) PageSize(pageSize int64) *ProjectsInstancesDatabasesSessionsListCall

PageSize sets the optional parameter "pageSize": Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

func (*ProjectsInstancesDatabasesSessionsListCall) PageToken Uses

func (c *ProjectsInstancesDatabasesSessionsListCall) PageToken(pageToken string) *ProjectsInstancesDatabasesSessionsListCall

PageToken sets the optional parameter "pageToken": If non-empty, `page_token` should contain a next_page_token from a previous ListSessionsResponse.

func (*ProjectsInstancesDatabasesSessionsListCall) Pages Uses

func (c *ProjectsInstancesDatabasesSessionsListCall) Pages(ctx context.Context, f func(*ListSessionsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsInstancesDatabasesSessionsPartitionQueryCall Uses

type ProjectsInstancesDatabasesSessionsPartitionQueryCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsPartitionQueryCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsPartitionQueryCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsPartitionQueryCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsPartitionQueryCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsPartitionQueryCall) Do(opts ...googleapi.CallOption) (*PartitionResponse, error)

Do executes the "spanner.projects.instances.databases.sessions.partitionQuery" call. Exactly one of *PartitionResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PartitionResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsPartitionQueryCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsPartitionQueryCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsPartitionQueryCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsPartitionQueryCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsPartitionQueryCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesSessionsPartitionReadCall Uses

type ProjectsInstancesDatabasesSessionsPartitionReadCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsPartitionReadCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsPartitionReadCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsPartitionReadCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsPartitionReadCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsPartitionReadCall) Do(opts ...googleapi.CallOption) (*PartitionResponse, error)

Do executes the "spanner.projects.instances.databases.sessions.partitionRead" call. Exactly one of *PartitionResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PartitionResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsPartitionReadCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsPartitionReadCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsPartitionReadCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsPartitionReadCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsPartitionReadCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesSessionsReadCall Uses

type ProjectsInstancesDatabasesSessionsReadCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsReadCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsReadCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsReadCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsReadCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsReadCall) Do(opts ...googleapi.CallOption) (*ResultSet, error)

Do executes the "spanner.projects.instances.databases.sessions.read" call. Exactly one of *ResultSet or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ResultSet.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsReadCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsReadCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsReadCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsReadCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsReadCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesSessionsRollbackCall Uses

type ProjectsInstancesDatabasesSessionsRollbackCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsRollbackCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsRollbackCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsRollbackCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsRollbackCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsRollbackCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "spanner.projects.instances.databases.sessions.rollback" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsRollbackCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsRollbackCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsRollbackCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsRollbackCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsRollbackCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesSessionsService Uses

type ProjectsInstancesDatabasesSessionsService struct {
    // contains filtered or unexported fields
}

func NewProjectsInstancesDatabasesSessionsService Uses

func NewProjectsInstancesDatabasesSessionsService(s *Service) *ProjectsInstancesDatabasesSessionsService

func (*ProjectsInstancesDatabasesSessionsService) BeginTransaction Uses

func (r *ProjectsInstancesDatabasesSessionsService) BeginTransaction(session string, begintransactionrequest *BeginTransactionRequest) *ProjectsInstancesDatabasesSessionsBeginTransactionCall

BeginTransaction: Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.

func (*ProjectsInstancesDatabasesSessionsService) Commit Uses

func (r *ProjectsInstancesDatabasesSessionsService) Commit(session string, commitrequest *CommitRequest) *ProjectsInstancesDatabasesSessionsCommitCall

Commit: Commits a transaction. The request includes the mutations to be applied to rows in the database.

`Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session.

func (*ProjectsInstancesDatabasesSessionsService) Create Uses

func (r *ProjectsInstancesDatabasesSessionsService) Create(database string, createsessionrequest *CreateSessionRequest) *ProjectsInstancesDatabasesSessionsCreateCall

Create: Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions.

Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit.

Cloud Spanner limits the number of sessions that can exist at any given time; thus, it is a good idea to delete idle and/or unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`.

Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., "SELECT 1".

func (*ProjectsInstancesDatabasesSessionsService) Delete Uses

func (r *ProjectsInstancesDatabasesSessionsService) Delete(name string) *ProjectsInstancesDatabasesSessionsDeleteCall

Delete: Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.

func (*ProjectsInstancesDatabasesSessionsService) ExecuteBatchDml Uses

func (r *ProjectsInstancesDatabasesSessionsService) ExecuteBatchDml(session string, executebatchdmlrequest *ExecuteBatchDmlRequest) *ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall

ExecuteBatchDml: Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql.

Statements are executed in order, sequentially. ExecuteBatchDmlResponse will contain a ResultSet for each DML statement that has successfully executed. If a statement fails, its error status will be returned as part of the ExecuteBatchDmlResponse. Execution will stop at the first failed statement; the remaining statements will not run.

ExecuteBatchDml is expected to return an OK status with a response even if there was an error while processing one of the DML statements. Clients must inspect response.status to determine if there were any errors while processing the request.

See more details in ExecuteBatchDmlRequest and ExecuteBatchDmlResponse.

func (*ProjectsInstancesDatabasesSessionsService) ExecuteSql Uses

func (r *ProjectsInstancesDatabasesSessionsService) ExecuteSql(session string, executesqlrequest *ExecuteSqlRequest) *ProjectsInstancesDatabasesSessionsExecuteSqlCall

ExecuteSql: Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error.

Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details.

Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.

func (*ProjectsInstancesDatabasesSessionsService) ExecuteStreamingSql Uses

func (r *ProjectsInstancesDatabasesSessionsService) ExecuteStreamingSql(session string, executesqlrequest *ExecuteSqlRequest) *ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall

ExecuteStreamingSql: Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

func (*ProjectsInstancesDatabasesSessionsService) Get Uses

func (r *ProjectsInstancesDatabasesSessionsService) Get(name string) *ProjectsInstancesDatabasesSessionsGetCall

Get: Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive.

func (*ProjectsInstancesDatabasesSessionsService) List Uses

func (r *ProjectsInstancesDatabasesSessionsService) List(database string) *ProjectsInstancesDatabasesSessionsListCall

List: Lists all sessions in a given database.

func (*ProjectsInstancesDatabasesSessionsService) PartitionQuery Uses

func (r *ProjectsInstancesDatabasesSessionsService) PartitionQuery(session string, partitionqueryrequest *PartitionQueryRequest) *ProjectsInstancesDatabasesSessionsPartitionQueryCall

PartitionQuery: Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens.

Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.

func (*ProjectsInstancesDatabasesSessionsService) PartitionRead Uses

func (r *ProjectsInstancesDatabasesSessionsService) PartitionRead(session string, partitionreadrequest *PartitionReadRequest) *ProjectsInstancesDatabasesSessionsPartitionReadCall

PartitionRead: Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token.

Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.

func (*ProjectsInstancesDatabasesSessionsService) Read Uses

func (r *ProjectsInstancesDatabasesSessionsService) Read(session string, readrequest *ReadRequest) *ProjectsInstancesDatabasesSessionsReadCall

Read: Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error.

Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details.

Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.

func (*ProjectsInstancesDatabasesSessionsService) Rollback Uses

func (r *ProjectsInstancesDatabasesSessionsService) Rollback(session string, rollbackrequest *RollbackRequest) *ProjectsInstancesDatabasesSessionsRollbackCall

Rollback: Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit.

`Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`.

func (*ProjectsInstancesDatabasesSessionsService) StreamingRead Uses

func (r *ProjectsInstancesDatabasesSessionsService) StreamingRead(session string, readrequest *ReadRequest) *ProjectsInstancesDatabasesSessionsStreamingReadCall

StreamingRead: Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

type ProjectsInstancesDatabasesSessionsStreamingReadCall Uses

type ProjectsInstancesDatabasesSessionsStreamingReadCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSessionsStreamingReadCall) Context Uses

func (c *ProjectsInstancesDatabasesSessionsStreamingReadCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSessionsStreamingReadCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsStreamingReadCall) Do Uses

func (c *ProjectsInstancesDatabasesSessionsStreamingReadCall) Do(opts ...googleapi.CallOption) (*PartialResultSet, error)

Do executes the "spanner.projects.instances.databases.sessions.streamingRead" call. Exactly one of *PartialResultSet or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PartialResultSet.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSessionsStreamingReadCall) Fields Uses

func (c *ProjectsInstancesDatabasesSessionsStreamingReadCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSessionsStreamingReadCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSessionsStreamingReadCall) Header Uses

func (c *ProjectsInstancesDatabasesSessionsStreamingReadCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesSetIamPolicyCall Uses

type ProjectsInstancesDatabasesSetIamPolicyCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesSetIamPolicyCall) Context Uses

func (c *ProjectsInstancesDatabasesSetIamPolicyCall) Context(ctx context.Context) *ProjectsInstancesDatabasesSetIamPolicyCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSetIamPolicyCall) Do Uses

func (c *ProjectsInstancesDatabasesSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "spanner.projects.instances.databases.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesSetIamPolicyCall) Fields Uses

func (c *ProjectsInstancesDatabasesSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesSetIamPolicyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesSetIamPolicyCall) Header Uses

func (c *ProjectsInstancesDatabasesSetIamPolicyCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesTestIamPermissionsCall Uses

type ProjectsInstancesDatabasesTestIamPermissionsCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesTestIamPermissionsCall) Context Uses

func (c *ProjectsInstancesDatabasesTestIamPermissionsCall) Context(ctx context.Context) *ProjectsInstancesDatabasesTestIamPermissionsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesTestIamPermissionsCall) Do Uses

func (c *ProjectsInstancesDatabasesTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

Do executes the "spanner.projects.instances.databases.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesTestIamPermissionsCall) Fields Uses

func (c *ProjectsInstancesDatabasesTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesTestIamPermissionsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesTestIamPermissionsCall) Header Uses

func (c *ProjectsInstancesDatabasesTestIamPermissionsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDatabasesUpdateDdlCall Uses

type ProjectsInstancesDatabasesUpdateDdlCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDatabasesUpdateDdlCall) Context Uses

func (c *ProjectsInstancesDatabasesUpdateDdlCall) Context(ctx context.Context) *ProjectsInstancesDatabasesUpdateDdlCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesUpdateDdlCall) Do Uses

func (c *ProjectsInstancesDatabasesUpdateDdlCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "spanner.projects.instances.databases.updateDdl" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDatabasesUpdateDdlCall) Fields Uses

func (c *ProjectsInstancesDatabasesUpdateDdlCall) Fields(s ...googleapi.Field) *ProjectsInstancesDatabasesUpdateDdlCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDatabasesUpdateDdlCall) Header Uses

func (c *ProjectsInstancesDatabasesUpdateDdlCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesDeleteCall Uses

type ProjectsInstancesDeleteCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesDeleteCall) Context Uses

func (c *ProjectsInstancesDeleteCall) Context(ctx context.Context) *ProjectsInstancesDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDeleteCall) Do Uses

func (c *ProjectsInstancesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "spanner.projects.instances.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDeleteCall) Fields Uses

func (c *ProjectsInstancesDeleteCall) Fields(s ...googleapi.Field) *ProjectsInstancesDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesDeleteCall) Header Uses

func (c *ProjectsInstancesDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesGetCall Uses

type ProjectsInstancesGetCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesGetCall) Context Uses

func (c *ProjectsInstancesGetCall) Context(ctx context.Context) *ProjectsInstancesGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesGetCall) Do Uses

func (c *ProjectsInstancesGetCall) Do(opts ...googleapi.CallOption) (*Instance, error)

Do executes the "spanner.projects.instances.get" call. Exactly one of *Instance or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Instance.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesGetCall) Fields Uses

func (c *ProjectsInstancesGetCall) Fields(s ...googleapi.Field) *ProjectsInstancesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesGetCall) Header Uses

func (c *ProjectsInstancesGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsInstancesGetCall) IfNoneMatch Uses

func (c *ProjectsInstancesGetCall) IfNoneMatch(entityTag string) *ProjectsInstancesGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesGetIamPolicyCall Uses

type ProjectsInstancesGetIamPolicyCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesGetIamPolicyCall) Context Uses

func (c *ProjectsInstancesGetIamPolicyCall) Context(ctx context.Context) *ProjectsInstancesGetIamPolicyCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesGetIamPolicyCall) Do Uses

func (c *ProjectsInstancesGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "spanner.projects.instances.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesGetIamPolicyCall) Fields Uses

func (c *ProjectsInstancesGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsInstancesGetIamPolicyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesGetIamPolicyCall) Header Uses

func (c *ProjectsInstancesGetIamPolicyCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesListCall Uses

type ProjectsInstancesListCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesListCall) Context Uses

func (c *ProjectsInstancesListCall) Context(ctx context.Context) *ProjectsInstancesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesListCall) Do Uses

func (c *ProjectsInstancesListCall) Do(opts ...googleapi.CallOption) (*ListInstancesResponse, error)

Do executes the "spanner.projects.instances.list" call. Exactly one of *ListInstancesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListInstancesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesListCall) Fields Uses

func (c *ProjectsInstancesListCall) Fields(s ...googleapi.Field) *ProjectsInstancesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesListCall) Filter Uses

func (c *ProjectsInstancesListCall) Filter(filter string) *ProjectsInstancesListCall

Filter sets the optional parameter "filter": An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

* `name`
* `display_name`
* `labels.key` where key is the name of a label

Some examples of using filters are:

* `name:*` --> The instance has a name.
* `name:Howl` --> The instance's name contains the string "howl".
* `name:HOWL` --> Equivalent to above.
* `NAME:howl` --> Equivalent to above.
* `labels.env:*` --> The instance has the label "env".
* `labels.env:dev` --> The instance has the label "env" and the

value of

                     the label contains the string "dev".
* `name:howl labels.env:dev` --> The instance's name contains

"howl" and

it has the label "env" with its

value

containing "dev".

func (*ProjectsInstancesListCall) Header Uses

func (c *ProjectsInstancesListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsInstancesListCall) IfNoneMatch Uses

func (c *ProjectsInstancesListCall) IfNoneMatch(entityTag string) *ProjectsInstancesListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesListCall) PageSize Uses

func (c *ProjectsInstancesListCall) PageSize(pageSize int64) *ProjectsInstancesListCall

PageSize sets the optional parameter "pageSize": Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

func (*ProjectsInstancesListCall) PageToken Uses

func (c *ProjectsInstancesListCall) PageToken(pageToken string) *ProjectsInstancesListCall

PageToken sets the optional parameter "pageToken": If non-empty, `page_token` should contain a next_page_token from a previous ListInstancesResponse.

func (*ProjectsInstancesListCall) Pages Uses

func (c *ProjectsInstancesListCall) Pages(ctx context.Context, f func(*ListInstancesResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsInstancesOperationsCancelCall Uses

type ProjectsInstancesOperationsCancelCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesOperationsCancelCall) Context Uses

func (c *ProjectsInstancesOperationsCancelCall) Context(ctx context.Context) *ProjectsInstancesOperationsCancelCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesOperationsCancelCall) Do Uses

func (c *ProjectsInstancesOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "spanner.projects.instances.operations.cancel" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesOperationsCancelCall) Fields Uses

func (c *ProjectsInstancesOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsInstancesOperationsCancelCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesOperationsCancelCall) Header Uses

func (c *ProjectsInstancesOperationsCancelCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesOperationsDeleteCall Uses

type ProjectsInstancesOperationsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesOperationsDeleteCall) Context Uses

func (c *ProjectsInstancesOperationsDeleteCall) Context(ctx context.Context) *ProjectsInstancesOperationsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesOperationsDeleteCall) Do Uses

func (c *ProjectsInstancesOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "spanner.projects.instances.operations.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesOperationsDeleteCall) Fields Uses

func (c *ProjectsInstancesOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsInstancesOperationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesOperationsDeleteCall) Header Uses

func (c *ProjectsInstancesOperationsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesOperationsGetCall Uses

type ProjectsInstancesOperationsGetCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesOperationsGetCall) Context Uses

func (c *ProjectsInstancesOperationsGetCall) Context(ctx context.Context) *ProjectsInstancesOperationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesOperationsGetCall) Do Uses

func (c *ProjectsInstancesOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "spanner.projects.instances.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesOperationsGetCall) Fields Uses

func (c *ProjectsInstancesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsInstancesOperationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesOperationsGetCall) Header Uses

func (c *ProjectsInstancesOperationsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsInstancesOperationsGetCall) IfNoneMatch Uses

func (c *ProjectsInstancesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsInstancesOperationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesOperationsListCall Uses

type ProjectsInstancesOperationsListCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesOperationsListCall) Context Uses

func (c *ProjectsInstancesOperationsListCall) Context(ctx context.Context) *ProjectsInstancesOperationsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesOperationsListCall) Do Uses

func (c *ProjectsInstancesOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)

Do executes the "spanner.projects.instances.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesOperationsListCall) Fields Uses

func (c *ProjectsInstancesOperationsListCall) Fields(s ...googleapi.Field) *ProjectsInstancesOperationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesOperationsListCall) Filter Uses

func (c *ProjectsInstancesOperationsListCall) Filter(filter string) *ProjectsInstancesOperationsListCall

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsInstancesOperationsListCall) Header Uses

func (c *ProjectsInstancesOperationsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsInstancesOperationsListCall) IfNoneMatch Uses

func (c *ProjectsInstancesOperationsListCall) IfNoneMatch(entityTag string) *ProjectsInstancesOperationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesOperationsListCall) PageSize Uses

func (c *ProjectsInstancesOperationsListCall) PageSize(pageSize int64) *ProjectsInstancesOperationsListCall

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsInstancesOperationsListCall) PageToken Uses

func (c *ProjectsInstancesOperationsListCall) PageToken(pageToken string) *ProjectsInstancesOperationsListCall

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsInstancesOperationsListCall) Pages Uses

func (c *ProjectsInstancesOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsInstancesOperationsService Uses

type ProjectsInstancesOperationsService struct {
    // contains filtered or unexported fields
}

func NewProjectsInstancesOperationsService Uses

func NewProjectsInstancesOperationsService(s *Service) *ProjectsInstancesOperationsService

func (*ProjectsInstancesOperationsService) Cancel Uses

func (r *ProjectsInstancesOperationsService) Cancel(name string) *ProjectsInstancesOperationsCancelCall

Cancel: Starts asynchronous cancellation on a long-running operation.

The server

makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

func (*ProjectsInstancesOperationsService) Delete Uses

func (r *ProjectsInstancesOperationsService) Delete(name string) *ProjectsInstancesOperationsDeleteCall

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

func (*ProjectsInstancesOperationsService) Get Uses

func (r *ProjectsInstancesOperationsService) Get(name string) *ProjectsInstancesOperationsGetCall

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

func (*ProjectsInstancesOperationsService) List Uses

func (r *ProjectsInstancesOperationsService) List(name string) *ProjectsInstancesOperationsListCall

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

type ProjectsInstancesPatchCall Uses

type ProjectsInstancesPatchCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesPatchCall) Context Uses

func (c *ProjectsInstancesPatchCall) Context(ctx context.Context) *ProjectsInstancesPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesPatchCall) Do Uses

func (c *ProjectsInstancesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "spanner.projects.instances.patch" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesPatchCall) Fields Uses

func (c *ProjectsInstancesPatchCall) Fields(s ...googleapi.Field) *ProjectsInstancesPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesPatchCall) Header Uses

func (c *ProjectsInstancesPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesService Uses

type ProjectsInstancesService struct {
    Databases *ProjectsInstancesDatabasesService

    Operations *ProjectsInstancesOperationsService
    // contains filtered or unexported fields
}

func NewProjectsInstancesService Uses

func NewProjectsInstancesService(s *Service) *ProjectsInstancesService

func (*ProjectsInstancesService) Create Uses

func (r *ProjectsInstancesService) Create(parent string, createinstancerequest *CreateInstanceRequest) *ProjectsInstancesCreateCall

Create: Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, `CreateInstance` returns `ALREADY_EXISTS`.

Immediately upon completion of this request:

* The instance is readable via the API, with all requested

attributes

but no allocated resources. Its state is `CREATING`.

Until completion of the returned operation:

* Cancelling the operation renders the instance immediately

unreadable

  via the API.
* The instance can be deleted.
* All other attempts to modify the instance are rejected.

Upon completion of the returned operation:

* Billing for all successfully-allocated resources begins (some

types

  may have lower than the requested levels).
* Databases can be created in the instance.
* The instance's allocated resource levels are readable via the

API.

* The instance's state becomes `READY`.

The returned long-running operation will have a name of the format `<instance_name>/operations/<operation_id>` and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful.

func (*ProjectsInstancesService) Delete Uses

func (r *ProjectsInstancesService) Delete(name string) *ProjectsInstancesDeleteCall

Delete: Deletes an instance.

Immediately upon completion of the request:

* Billing ceases for all of the instance's reserved

resources.

Soon afterward:

* The instance and *all of its databases* immediately and
  irrevocably disappear from the API. All data in the databases
  is permanently deleted.

func (*ProjectsInstancesService) Get Uses

func (r *ProjectsInstancesService) Get(name string) *ProjectsInstancesGetCall

Get: Gets information about a particular instance.

func (*ProjectsInstancesService) GetIamPolicy Uses

func (r *ProjectsInstancesService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *ProjectsInstancesGetIamPolicyCall

GetIamPolicy: Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.

Authorization requires `spanner.instances.getIamPolicy` on resource.

func (*ProjectsInstancesService) List Uses

func (r *ProjectsInstancesService) List(parent string) *ProjectsInstancesListCall

List: Lists all instances in the given project.

func (*ProjectsInstancesService) Patch Uses

func (r *ProjectsInstancesService) Patch(nameid string, updateinstancerequest *UpdateInstanceRequest) *ProjectsInstancesPatchCall

Patch: Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`.

Immediately upon completion of this request:

* For resource types for which a decrease in the instance's

allocation

has been requested, billing is based on the newly-requested

level.

Until completion of the returned operation:

* Cancelling the operation sets its metadata's
  cancel_time, and begins
  restoring resources to their pre-request values. The operation
  is guaranteed to succeed at undoing all resource changes,
  after which point it terminates with a `CANCELLED` status.
* All other attempts to modify the instance are rejected.
* Reading the instance via the API continues to give the

pre-request

resource levels.

Upon completion of the returned operation:

* Billing begins for all successfully-allocated resources (some

types

  may have lower than the requested levels).
* All newly-reserved resources are available for serving the

instance's

  tables.
* The instance's new resource levels are readable via the API.

The returned long-running operation will have a name of the format `<instance_name>/operations/<operation_id>` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful.

Authorization requires `spanner.instances.update` permission on resource name.

func (*ProjectsInstancesService) SetIamPolicy Uses

func (r *ProjectsInstancesService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsInstancesSetIamPolicyCall

SetIamPolicy: Sets the access control policy on an instance resource. Replaces any existing policy.

Authorization requires `spanner.instances.setIamPolicy` on resource.

func (*ProjectsInstancesService) TestIamPermissions Uses

func (r *ProjectsInstancesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsInstancesTestIamPermissionsCall

TestIamPermissions: Returns permissions that the caller has on the specified instance resource.

Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.

type ProjectsInstancesSetIamPolicyCall Uses

type ProjectsInstancesSetIamPolicyCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesSetIamPolicyCall) Context Uses

func (c *ProjectsInstancesSetIamPolicyCall) Context(ctx context.Context) *ProjectsInstancesSetIamPolicyCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesSetIamPolicyCall) Do Uses

func (c *ProjectsInstancesSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "spanner.projects.instances.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesSetIamPolicyCall) Fields Uses

func (c *ProjectsInstancesSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsInstancesSetIamPolicyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesSetIamPolicyCall) Header Uses

func (c *ProjectsInstancesSetIamPolicyCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsInstancesTestIamPermissionsCall Uses

type ProjectsInstancesTestIamPermissionsCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsInstancesTestIamPermissionsCall) Context Uses

func (c *ProjectsInstancesTestIamPermissionsCall) Context(ctx context.Context) *ProjectsInstancesTestIamPermissionsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesTestIamPermissionsCall) Do Uses

func (c *ProjectsInstancesTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

Do executes the "spanner.projects.instances.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTestIamPermissionsCall) Fields Uses

func (c *ProjectsInstancesTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsInstancesTestIamPermissionsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsInstancesTestIamPermissionsCall) Header Uses

func (c *ProjectsInstancesTestIamPermissionsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsService Uses

type ProjectsService struct {
    InstanceConfigs *ProjectsInstanceConfigsService

    Instances *ProjectsInstancesService
    // contains filtered or unexported fields
}

func NewProjectsService Uses

func NewProjectsService(s *Service) *ProjectsService

type QueryPlan Uses

type QueryPlan struct {
    // PlanNodes: The nodes in the query plan. Plan nodes are returned in
    // pre-order starting
    // with the plan root. Each PlanNode's `id` corresponds to its index
    // in
    // `plan_nodes`.
    PlanNodes []*PlanNode `json:"planNodes,omitempty"`

    // ForceSendFields is a list of field names (e.g. "PlanNodes") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "PlanNodes") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

QueryPlan: Contains an ordered list of nodes appearing in the query plan.

func (*QueryPlan) MarshalJSON Uses

func (s *QueryPlan) MarshalJSON() ([]byte, error)

type ReadOnly Uses

type ReadOnly struct {
    // ExactStaleness: Executes all reads at a timestamp that is
    // `exact_staleness`
    // old. The timestamp is chosen soon after the read is
    // started.
    //
    // Guarantees that all writes that have committed more than
    // the
    // specified number of seconds ago are visible. Because Cloud
    // Spanner
    // chooses the exact timestamp, this mode works even if the
    // client's
    // local clock is substantially skewed from Cloud Spanner
    // commit
    // timestamps.
    //
    // Useful for reading at nearby replicas without the
    // distributed
    // timestamp negotiation overhead of `max_staleness`.
    ExactStaleness string `json:"exactStaleness,omitempty"`

    // MaxStaleness: Read data at a timestamp >= `NOW -
    // max_staleness`
    // seconds. Guarantees that all writes that have committed more
    // than the specified number of seconds ago are visible. Because
    // Cloud Spanner chooses the exact timestamp, this mode works even
    // if
    // the client's local clock is substantially skewed from Cloud
    // Spanner
    // commit timestamps.
    //
    // Useful for reading the freshest data available at a nearby
    // replica, while bounding the possible staleness if the local
    // replica has fallen behind.
    //
    // Note that this option can only be used in single-use
    // transactions.
    MaxStaleness string `json:"maxStaleness,omitempty"`

    // MinReadTimestamp: Executes all reads at a timestamp >=
    // `min_read_timestamp`.
    //
    // This is useful for requesting fresher data than some previous
    // read, or data that is fresh enough to observe the effects of
    // some
    // previously committed transaction whose timestamp is known.
    //
    // Note that this option can only be used in single-use transactions.
    //
    // A timestamp in RFC3339 UTC \"Zulu\" format, accurate to
    // nanoseconds.
    // Example: "2014-10-02T15:01:23.045123456Z".
    MinReadTimestamp string `json:"minReadTimestamp,omitempty"`

    // ReadTimestamp: Executes all reads at the given timestamp. Unlike
    // other modes,
    // reads at a specific timestamp are repeatable; the same read at
    // the same timestamp always returns the same data. If the
    // timestamp is in the future, the read will block until the
    // specified timestamp, modulo the read's deadline.
    //
    // Useful for large scale consistent reads such as mapreduces, or
    // for coordinating many reads against a consistent snapshot of
    // the
    // data.
    //
    // A timestamp in RFC3339 UTC \"Zulu\" format, accurate to
    // nanoseconds.
    // Example: "2014-10-02T15:01:23.045123456Z".
    ReadTimestamp string `json:"readTimestamp,omitempty"`

    // ReturnReadTimestamp: If true, the Cloud Spanner-selected read
    // timestamp is included in
    // the Transaction message that describes the transaction.
    ReturnReadTimestamp bool `json:"returnReadTimestamp,omitempty"`

    // Strong: Read at a timestamp where all previously committed
    // transactions
    // are visible.
    Strong bool `json:"strong,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ExactStaleness") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ExactStaleness") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

ReadOnly: Message type to initiate a read-only transaction.

func (*ReadOnly) MarshalJSON Uses

func (s *ReadOnly) MarshalJSON() ([]byte, error)

type ReadRequest Uses

type ReadRequest struct {
    // Columns: The columns of table to be returned for each row
    // matching
    // this request.
    Columns []string `json:"columns,omitempty"`

    // Index: If non-empty, the name of an index on table. This index
    // is
    // used instead of the table primary key when interpreting key_set
    // and sorting result rows. See key_set for further information.
    Index string `json:"index,omitempty"`

    // KeySet: Required. `key_set` identifies the rows to be yielded.
    // `key_set` names the
    // primary keys of the rows in table to be yielded, unless index
    // is present. If index is present, then key_set instead names
    // index keys in index.
    //
    // If the partition_token field is empty, rows are yielded
    // in table primary key order (if index is empty) or index key order
    // (if index is non-empty).  If the partition_token field is not
    // empty, rows will be yielded in an unspecified order.
    //
    // It is not an error for the `key_set` to name rows that do not
    // exist in the database. Read yields nothing for nonexistent rows.
    KeySet *KeySet `json:"keySet,omitempty"`

    // Limit: If greater than zero, only the first `limit` rows are yielded.
    // If `limit`
    // is zero, the default is no limit. A limit cannot be specified
    // if
    // `partition_token` is set.
    Limit int64 `json:"limit,omitempty,string"`

    // PartitionToken: If present, results will be restricted to the
    // specified partition
    // previously created using PartitionRead().    There must be an
    // exact
    // match for the values of fields common to this message and
    // the
    // PartitionReadRequest message used to create this partition_token.
    PartitionToken string `json:"partitionToken,omitempty"`

    // ResumeToken: If this request is resuming a previously interrupted
    // read,
    // `resume_token` should be copied from the last
    // PartialResultSet yielded before the interruption. Doing this
    // enables the new read to resume where the last read left off. The
    // rest of the request parameters must exactly match the request
    // that yielded this token.
    ResumeToken string `json:"resumeToken,omitempty"`

    // Table: Required. The name of the table in the database to be read.
    Table string `json:"table,omitempty"`

    // Transaction: The transaction to use. If none is provided, the default
    // is a
    // temporary read-only transaction with strong concurrency.
    Transaction *TransactionSelector `json:"transaction,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Columns") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Columns") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ReadRequest: The request for Read and StreamingRead.

func (*ReadRequest) MarshalJSON Uses

func (s *ReadRequest) MarshalJSON() ([]byte, error)

type ReadWrite Uses

type ReadWrite struct {
}

ReadWrite: Message type to initiate a read-write transaction. Currently this transaction type has no options.

type ReplicaInfo Uses

type ReplicaInfo struct {
    // DefaultLeaderLocation: If true, this location is designated as the
    // default leader location where
    // leader replicas are placed. See the [region
    // types
    // documentation](https://cloud.google.com/spanner/docs/instances#r
    // egion_types)
    // for more details.
    DefaultLeaderLocation bool `json:"defaultLeaderLocation,omitempty"`

    // Location: The location of the serving resources, e.g. "us-central1".
    Location string `json:"location,omitempty"`

    // Type: The type of replica.
    //
    // Possible values:
    //   "TYPE_UNSPECIFIED" - Not specified.
    //   "READ_WRITE" - Read-write replicas support both reads and writes.
    // These replicas:
    //
    // * Maintain a full copy of your data.
    // * Serve reads.
    // * Can vote whether to commit a write.
    // * Participate in leadership election.
    // * Are eligible to become a leader.
    //   "READ_ONLY" - Read-only replicas only support reads (not writes).
    // Read-only replicas:
    //
    // * Maintain a full copy of your data.
    // * Serve reads.
    // * Do not participate in voting to commit writes.
    // * Are not eligible to become a leader.
    //   "WITNESS" - Witness replicas don't support reads but do participate
    // in voting to
    // commit writes. Witness replicas:
    //
    // * Do not maintain a full copy of data.
    // * Do not serve reads.
    // * Vote whether to commit writes.
    // * Participate in leader election but are not eligible to become
    // leader.
    Type string `json:"type,omitempty"`

    // ForceSendFields is a list of field names (e.g.
    // "DefaultLeaderLocation") to unconditionally include in API requests.
    // By default, fields with empty values are omitted from API requests.
    // However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "DefaultLeaderLocation") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*ReplicaInfo) MarshalJSON Uses

func (s *ReplicaInfo) MarshalJSON() ([]byte, error)

type ResultSet Uses

type ResultSet struct {
    // Metadata: Metadata about the result set, such as row type
    // information.
    Metadata *ResultSetMetadata `json:"metadata,omitempty"`

    // Rows: Each element in `rows` is a row whose format is defined
    // by
    // metadata.row_type. The ith element
    // in each row matches the ith field in
    // metadata.row_type. Elements are
    // encoded based on type as described
    // here.
    Rows [][]interface{} `json:"rows,omitempty"`

    // Stats: Query plan and execution statistics for the SQL statement
    // that
    // produced this result set. These can be requested by
    // setting
    // ExecuteSqlRequest.query_mode.
    // DML statements always produce stats containing the number of
    // rows
    // modified, unless executed using the
    // ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode.
    // Other fields may or may not be populated, based on
    // the
    // ExecuteSqlRequest.query_mode.
    Stats *ResultSetStats `json:"stats,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Metadata") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Metadata") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ResultSet: Results from Read or ExecuteSql.

func (*ResultSet) MarshalJSON Uses

func (s *ResultSet) MarshalJSON() ([]byte, error)

type ResultSetMetadata Uses

type ResultSetMetadata struct {
    // RowType: Indicates the field names and types for the rows in the
    // result
    // set.  For example, a SQL query like "SELECT UserId, UserName
    // FROM
    // Users" could return a `row_type` value like:
    //
    //     "fields": [
    //       { "name": "UserId", "type": { "code": "INT64" } },
    //       { "name": "UserName", "type": { "code": "STRING" } },
    //     ]
    RowType *StructType `json:"rowType,omitempty"`

    // Transaction: If the read or SQL query began a transaction as a
    // side-effect, the
    // information about the new transaction is yielded here.
    Transaction *Transaction `json:"transaction,omitempty"`

    // ForceSendFields is a list of field names (e.g. "RowType") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "RowType") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ResultSetMetadata: Metadata about a ResultSet or PartialResultSet.

func (*ResultSetMetadata) MarshalJSON Uses

func (s *ResultSetMetadata) MarshalJSON() ([]byte, error)

type ResultSetStats Uses

type ResultSetStats struct {
    // QueryPlan: QueryPlan for the query associated with this result.
    QueryPlan *QueryPlan `json:"queryPlan,omitempty"`

    // QueryStats: Aggregated statistics from the execution of the query.
    // Only present when
    // the query is profiled. For example, a query could return the
    // statistics as
    // follows:
    //
    //     {
    //       "rows_returned": "3",
    //       "elapsed_time": "1.22 secs",
    //       "cpu_time": "1.19 secs"
    //     }
    QueryStats googleapi.RawMessage `json:"queryStats,omitempty"`

    // RowCountExact: Standard DML returns an exact count of rows that were
    // modified.
    RowCountExact int64 `json:"rowCountExact,omitempty,string"`

    // RowCountLowerBound: Partitioned DML does not offer exactly-once
    // semantics, so it
    // returns a lower bound of the rows modified.
    RowCountLowerBound int64 `json:"rowCountLowerBound,omitempty,string"`

    // ForceSendFields is a list of field names (e.g. "QueryPlan") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "QueryPlan") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ResultSetStats: Additional statistics about a ResultSet or PartialResultSet.

func (*ResultSetStats) MarshalJSON Uses

func (s *ResultSetStats) MarshalJSON() ([]byte, error)

type RollbackRequest Uses

type RollbackRequest struct {
    // TransactionId: Required. The transaction to roll back.
    TransactionId string `json:"transactionId,omitempty"`

    // ForceSendFields is a list of field names (e.g. "TransactionId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "TransactionId") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

RollbackRequest: The request for Rollback.

func (*RollbackRequest) MarshalJSON Uses

func (s *RollbackRequest) MarshalJSON() ([]byte, error)

type Service Uses

type Service struct {
    BasePath  string // API endpoint base URL
    UserAgent string // optional additional User-Agent fragment

    Projects *ProjectsService
    // contains filtered or unexported fields
}

func New Uses

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService Uses

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type Session Uses

type Session struct {
    // ApproximateLastUseTime: Output only. The approximate timestamp when
    // the session is last used. It is
    // typically earlier than the actual last use time.
    ApproximateLastUseTime string `json:"approximateLastUseTime,omitempty"`

    // CreateTime: Output only. The timestamp when the session is created.
    CreateTime string `json:"createTime,omitempty"`

    // Labels: The labels for the session.
    //
    //  * Label keys must be between 1 and 63 characters long and must
    // conform to
    //    the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
    //  * Label values must be between 0 and 63 characters long and must
    // conform
    //    to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
    //  * No more than 64 labels can be associated with a given
    // session.
    //
    // See https://goo.gl/xmQnxf for more information on and examples of
    // labels.
    Labels map[string]string `json:"labels,omitempty"`

    // Name: The name of the session. This is always system-assigned; values
    // provided
    // when creating a session are ignored.
    Name string `json:"name,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g.
    // "ApproximateLastUseTime") to unconditionally include in API requests.
    // By default, fields with empty values are omitted from API requests.
    // However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ApproximateLastUseTime")
    // to include in API requests with the JSON null value. By default,
    // fields with empty values are omitted from API requests. However, any
    // field with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

Session: A session in the Cloud Spanner API.

func (*Session) MarshalJSON Uses

func (s *Session) MarshalJSON() ([]byte, error)

type SetIamPolicyRequest Uses

type SetIamPolicyRequest struct {
    // Policy: REQUIRED: The complete policy to be applied to the
    // `resource`. The size of
    // the policy is limited to a few 10s of KB. An empty policy is a
    // valid policy but certain Cloud Platform services (such as
    // Projects)
    // might reject them.
    Policy *Policy `json:"policy,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Policy") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Policy") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (*SetIamPolicyRequest) MarshalJSON Uses

func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error)

type ShortRepresentation Uses

type ShortRepresentation struct {
    // Description: A string representation of the expression subtree rooted
    // at this node.
    Description string `json:"description,omitempty"`

    // Subqueries: A mapping of (subquery variable name) -> (subquery node
    // id) for cases
    // where the `description` string of this node references a
    // `SCALAR`
    // subquery contained in the expression subtree rooted at this node.
    // The
    // referenced `SCALAR` subquery may not necessarily be a direct child
    // of
    // this node.
    Subqueries map[string]int64 `json:"subqueries,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Description") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Description") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ShortRepresentation: Condensed representation of a node and its subtree. Only present for `SCALAR` PlanNode(s).

func (*ShortRepresentation) MarshalJSON Uses

func (s *ShortRepresentation) MarshalJSON() ([]byte, error)

type Statement Uses

type Statement struct {
    // ParamTypes: It is not always possible for Cloud Spanner to infer the
    // right SQL type
    // from a JSON value.  For example, values of type `BYTES` and values
    // of type `STRING` both appear in params as JSON strings.
    //
    // In these cases, `param_types` can be used to specify the exact
    // SQL type for some or all of the SQL statement parameters. See
    // the
    // definition of Type for more information
    // about SQL types.
    ParamTypes map[string]Type `json:"paramTypes,omitempty"`

    // Params: The DML string can contain parameter placeholders. A
    // parameter
    // placeholder consists of `'@'` followed by the parameter
    // name. Parameter names consist of any combination of letters,
    // numbers, and underscores.
    //
    // Parameters can appear anywhere that a literal value is expected.
    // The
    // same parameter name can be used more than once, for example:
    //   "WHERE id > @msg_id AND id < @msg_id + 100"
    //
    // It is an error to execute an SQL statement with unbound
    // parameters.
    //
    // Parameter values are specified using `params`, which is a JSON
    // object whose keys are parameter names, and whose values are
    // the
    // corresponding parameter values.
    Params googleapi.RawMessage `json:"params,omitempty"`

    // Sql: Required. The DML string.
    Sql string `json:"sql,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ParamTypes") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ParamTypes") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Statement: A single DML statement.

func (*Statement) MarshalJSON Uses

func (s *Statement) MarshalJSON() ([]byte, error)

type Status Uses

type Status struct {
    // Code: The status code, which should be an enum value of
    // google.rpc.Code.
    Code int64 `json:"code,omitempty"`

    // Details: A list of messages that carry the error details.  There is a
    // common set of
    // message types for APIs to use.
    Details []googleapi.RawMessage `json:"details,omitempty"`

    // Message: A developer-facing error message, which should be in
    // English. Any
    // user-facing error message should be localized and sent in
    // the
    // google.rpc.Status.details field, or localized by the client.
    Message string `json:"message,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Code") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Code") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

func (*Status) MarshalJSON Uses

func (s *Status) MarshalJSON() ([]byte, error)

type StructType Uses

type StructType struct {
    // Fields: The list of fields that make up this struct. Order
    // is
    // significant, because values of this struct type are represented
    // as
    // lists, where the order of field values matches the order of
    // fields in the StructType. In turn, the order of fields
    // matches the order of columns in a read request, or the order
    // of
    // fields in the `SELECT` clause of a query.
    Fields []*Field `json:"fields,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Fields") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Fields") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

StructType: `StructType` defines the fields of a STRUCT type.

func (*StructType) MarshalJSON Uses

func (s *StructType) MarshalJSON() ([]byte, error)

type TestIamPermissionsRequest Uses

type TestIamPermissionsRequest struct {
    // Permissions: REQUIRED: The set of permissions to check for
    // 'resource'.
    // Permissions with wildcards (such as '*', 'spanner.*',
    // 'spanner.instances.*') are not allowed.
    Permissions []string `json:"permissions,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Permissions") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Permissions") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (*TestIamPermissionsRequest) MarshalJSON Uses

func (s *TestIamPermissionsRequest) MarshalJSON() ([]byte, error)

type TestIamPermissionsResponse Uses

type TestIamPermissionsResponse struct {
    // Permissions: A subset of `TestPermissionsRequest.permissions` that
    // the caller is
    // allowed.
    Permissions []string `json:"permissions,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Permissions") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Permissions") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (*TestIamPermissionsResponse) MarshalJSON Uses

func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error)

type Transaction Uses

type Transaction struct {
    // Id: `id` may be used to identify the transaction in
    // subsequent
    // Read,
    // ExecuteSql,
    // Commit, or
    // Rollback calls.
    //
    // Single-use read-only transactions do not have IDs, because
    // single-use transactions do not support multiple requests.
    Id  string `json:"id,omitempty"`

    // ReadTimestamp: For snapshot read-only transactions, the read
    // timestamp chosen
    // for the transaction. Not returned by default:
    // see
    // TransactionOptions.ReadOnly.return_read_timestamp.
    //
    // A timestamp in RFC3339 UTC \"Zulu\" format, accurate to
    // nanoseconds.
    // Example: "2014-10-02T15:01:23.045123456Z".
    ReadTimestamp string `json:"readTimestamp,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Id") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Id") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Transaction: A transaction.

func (*Transaction) MarshalJSON Uses

func (s *Transaction) MarshalJSON() ([]byte, error)

type TransactionOptions Uses

type TransactionOptions struct {
    // PartitionedDml: Partitioned DML transaction.
    //
    // Authorization to begin a Partitioned DML transaction
    // requires
    // `spanner.databases.beginPartitionedDmlTransaction` permission
    // on the `session` resource.
    PartitionedDml *PartitionedDml `json:"partitionedDml,omitempty"`

    // ReadOnly: Transaction will not write.
    //
    // Authorization to begin a read-only transaction
    // requires
    // `spanner.databases.beginReadOnlyTransaction` permission
    // on the `session` resource.
    ReadOnly *ReadOnly `json:"readOnly,omitempty"`

    // ReadWrite: Transaction may write.
    //
    // Authorization to begin a read-write transaction
    // requires
    // `spanner.databases.beginOrRollbackReadWriteTransaction` permission
    // on the `session` resource.
    ReadWrite *ReadWrite `json:"readWrite,omitempty"`

    // ForceSendFields is a list of field names (e.g. "PartitionedDml") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "PartitionedDml") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

TransactionOptions: # Transactions

Each session can have at most one active transaction at a time. After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction.

# Transaction Modes

Cloud Spanner supports three transaction modes:

1. Locking read-write. This type of transaction is the only way
   to write data into Cloud Spanner. These transactions rely on
   pessimistic locking and, if necessary, two-phase commit.
   Locking read-write transactions may abort, requiring the
   application to retry.

2. Snapshot read-only. This transaction type provides guaranteed
   consistency across several reads, but does not allow
   writes. Snapshot read-only transactions can be configured to
   read at timestamps in the past. Snapshot read-only
   transactions do not need to be committed.

3. Partitioned DML. This type of transaction is used to execute
   a single Partitioned DML statement. Partitioned DML partitions
   the key space and runs the DML statement over each partition
   in parallel using separate, internal transactions that commit
   independently. Partitioned DML transactions do not need to be
   committed.

For transactions that only read, snapshot read-only transactions provide simpler semantics and are almost always faster. In particular, read-only transactions do not take locks, so they do not conflict with read-write transactions. As a consequence of not taking locks, they also do not abort, so retry loops are not needed.

Transactions may only read/write data in a single database. They may, however, read/write data in different tables within that database.

## Locking Read-Write Transactions

Locking transactions may be used to atomically read-modify-write data anywhere in a database. This type of transaction is externally consistent.

Clients should attempt to minimize the amount of time a transaction is active. Faster transactions commit with higher probability and cause less contention. Cloud Spanner attempts to keep read locks active as long as the transaction continues to do reads, and the transaction has not been terminated by Commit or Rollback. Long periods of inactivity at the client may cause Cloud Spanner to release a transaction's locks and abort it.

Conceptually, a read-write transaction consists of zero or more reads or SQL statements followed by Commit. At any time before Commit, the client can send a Rollback request to abort the transaction.

### Semantics

Cloud Spanner can commit the transaction if all read locks it acquired are still valid at commit time, and it is able to acquire write locks for all writes. Cloud Spanner can abort the transaction for any reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has not modified any user data in Cloud Spanner.

Unless the transaction commits, Cloud Spanner makes no guarantees about how long the transaction's locks were held for. It is an error to use Cloud Spanner locks for any sort of mutual exclusion other than between Cloud Spanner transactions themselves.

### Retrying Aborted Transactions

When a transaction aborts, the application can choose to retry the whole transaction again. To maximize the chances of successfully committing the retry, the client should execute the retry in the same session as the original attempt. The original session's lock priority increases with each consecutive abort, meaning that each attempt has a slightly better chance of success than the previous.

Under some circumstances (e.g., many transactions attempting to modify the same row(s)), a transaction can abort many times in a short period before successfully committing. Thus, it is not a good idea to cap the number of retries a transaction can attempt; instead, it is better to limit the total amount of wall time spent retrying.

### Idle Transactions

A transaction is considered idle if it has no outstanding reads or SQL queries and has not started a read or SQL query within the last 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don't hold on to locks indefinitely. In that case, the commit will fail with error `ABORTED`.

If this behavior is undesirable, periodically executing a simple SQL query in the transaction (e.g., `SELECT 1`) prevents the transaction from becoming idle.

## Snapshot Read-Only Transactions

Snapshot read-only transactions provides a simpler method than locking read-write transactions for doing several consistent reads. However, this type of transaction does not support writes.

Snapshot transactions do not take locks. Instead, they work by choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. Since they do not acquire locks, they do not block concurrent read-write transactions.

Unlike locking read-write transactions, snapshot read-only transactions never abort. They can fail if the chosen read timestamp is garbage collected; however, the default garbage collection policy is generous enough that most applications do not need to worry about this in practice.

Snapshot read-only transactions do not need to call Commit or Rollback (and in fact are not permitted to do so).

To execute a snapshot transaction, the client specifies a timestamp bound, which tells Cloud Spanner how to choose a read timestamp.

The types of timestamp bound are:

- Strong (the default).
- Bounded staleness.
- Exact staleness.

If the Cloud Spanner database to be read is geographically distributed, stale read-only transactions can execute more quickly than strong or read-write transaction, because they are able to execute far from the leader replica.

Each type of timestamp bound is discussed in detail below.

### Strong

Strong reads are guaranteed to see the effects of all transactions that have committed before the start of the read. Furthermore, all rows yielded by a single read are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction.

Strong reads are not repeatable: two consecutive strong read-only transactions might return inconsistent results if there are concurrent writes. If consistency across reads is required, the reads should be executed within a transaction or at an exact read timestamp.

See TransactionOptions.ReadOnly.strong.

### Exact Staleness

These timestamp bounds execute reads at a user-specified timestamp. Reads at a timestamp are guaranteed to see a consistent prefix of the global transaction history: they observe modifications done by all transactions with a commit timestamp <= the read timestamp, and observe none of the modifications done by transactions with a larger commit timestamp. They will block until all conflicting transactions that may be assigned commit timestamps <= the read timestamp have finished.

The timestamp can either be expressed as an absolute Cloud Spanner commit timestamp or a staleness relative to the current time.

These modes do not require a "negotiation phase" to pick a timestamp. As a result, they execute slightly faster than the equivalent boundedly stale concurrency modes. On the other hand, boundedly stale reads usually return fresher results.

See TransactionOptions.ReadOnly.read_timestamp and TransactionOptions.ReadOnly.exact_staleness.

### Bounded Staleness

Bounded staleness modes allow Cloud Spanner to pick the read timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses the newest timestamp within the staleness bound that allows execution of the reads at the closest available replica without blocking.

All rows yielded are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Boundedly stale reads are not repeatable: two stale reads, even if they use the same staleness bound, can execute at different timestamps and thus return inconsistent results.

Boundedly stale reads execute in two phases: the first phase negotiates a timestamp among all replicas needed to serve the read. In the second phase, reads are executed at the negotiated timestamp.

As a result of the two phase execution, bounded staleness reads are usually a little slower than comparable exact staleness reads. However, they are typically able to return fresher results, and are more likely to execute at the closest replica.

Because the timestamp negotiation requires up-front knowledge of which rows will be read, it can only be used with single-use read-only transactions.

See TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly.min_read_timestamp.

### Old Read Timestamps and Garbage Collection

Cloud Spanner continuously garbage collects deleted and overwritten data in the background to reclaim storage space. This process is known as "version GC". By default, version GC reclaims versions after they are one hour old. Because of this, Cloud Spanner cannot perform reads at read timestamps more than one hour in the past. This restriction also applies to in-progress reads and/or SQL queries whose timestamp become too old while executing. Reads and SQL queries with too-old read timestamps fail with the error `FAILED_PRECONDITION`.

## Partitioned DML Transactions

Partitioned DML transactions are used to execute DML statements with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, should prefer using ReadWrite transactions.

Partitioned DML partitions the keyspace and runs the DML statement on each partition in separate, internal transactions. These transactions commit automatically when complete, and run independently from one another.

To reduce lock contention, this execution strategy only acquires read locks on rows that match the WHERE clause of the statement. Additionally, the smaller per-partition transactions hold locks for less time.

That said, Partitioned DML is not a drop-in replacement for standard DML used in ReadWrite transactions.

- The DML statement must be fully-partitionable. Specifically, the

statement

must be expressible as the union of many statements which each

access only

  a single row of the table.

- The statement is not applied atomically to all rows of the table.

Rather,

the statement is applied atomically to partitions of the table,

in

independent transactions. Secondary index rows are updated

atomically

  with the base table rows.

- Partitioned DML does not guarantee exactly-once execution

semantics

against a partition. The statement will be applied at least once

to each

partition. It is strongly recommended that the DML statement

should be

idempotent to avoid unexpected results. For instance, it is

potentially

dangerous to run a statement such as
`UPDATE table SET column = column + 1` as it could be run multiple

times

  against some rows.

- The partitions are committed automatically - there is no support

for

Commit or Rollback. If the call returns an error, or if the client

issuing

the ExecuteSql call dies, it is possible that some rows had the

statement

executed on them successfully. It is also possible that statement

was

  never executed against other rows.

- Partitioned DML transactions may only contain the execution of a

single

  DML statement via ExecuteSql or ExecuteStreamingSql.

- If any error is encountered during the execution of the

partitioned DML

operation (for instance, a UNIQUE INDEX violation, division by

zero, or a

value that cannot be stored due to schema constraints), then the
operation is stopped at that point and an error is returned. It

is

possible that at this point, some partitions have been committed

(or even

committed multiple times), and other partitions have not been run

at all.

Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table.

func (*TransactionOptions) MarshalJSON Uses

func (s *TransactionOptions) MarshalJSON() ([]byte, error)

type TransactionSelector Uses

type TransactionSelector struct {
    // Begin: Begin a new transaction and execute this read or SQL query
    // in
    // it. The transaction ID of the new transaction is returned
    // in
    // ResultSetMetadata.transaction, which is a Transaction.
    Begin *TransactionOptions `json:"begin,omitempty"`

    // Id: Execute the read or SQL query in a previously-started
    // transaction.
    Id  string `json:"id,omitempty"`

    // SingleUse: Execute the read or SQL query in a temporary
    // transaction.
    // This is the most efficient way to execute a transaction that
    // consists of a single SQL query.
    SingleUse *TransactionOptions `json:"singleUse,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Begin") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Begin") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

TransactionSelector: This message is used to select the transaction in which a Read or ExecuteSql call runs.

See TransactionOptions for more information about transactions.

func (*TransactionSelector) MarshalJSON Uses

func (s *TransactionSelector) MarshalJSON() ([]byte, error)

type Type Uses

type Type struct {
    // ArrayElementType: If code == ARRAY, then `array_element_type`
    // is the type of the array elements.
    ArrayElementType *Type `json:"arrayElementType,omitempty"`

    // Code: Required. The TypeCode for this type.
    //
    // Possible values:
    //   "TYPE_CODE_UNSPECIFIED" - Not specified.
    //   "BOOL" - Encoded as JSON `true` or `false`.
    //   "INT64" - Encoded as `string`, in decimal format.
    //   "FLOAT64" - Encoded as `number`, or the strings "NaN",
    // "Infinity", or
    // "-Infinity".
    //   "TIMESTAMP" - Encoded as `string` in RFC 3339 timestamp format. The
    // time zone
    // must be present, and must be "Z".
    //
    // If the schema has the column option
    // `allow_commit_timestamp=true`, the placeholder
    // string
    // "spanner.commit_timestamp()" can be used to instruct the system
    // to insert the commit timestamp associated with the
    // transaction
    // commit.
    //   "DATE" - Encoded as `string` in RFC 3339 date format.
    //   "STRING" - Encoded as `string`.
    //   "BYTES" - Encoded as a base64-encoded `string`, as described in RFC
    // 4648,
    // section 4.
    //   "ARRAY" - Encoded as `list`, where the list elements are
    // represented
    // according to
    // array_element_type.
    //   "STRUCT" - Encoded as `list`, where list element `i` is represented
    // according
    // to [struct_type.fields[i]][google.spanner.v1.StructType.fields].
    Code string `json:"code,omitempty"`

    // StructType: If code == STRUCT, then `struct_type`
    // provides type information for the struct's fields.
    StructType *StructType `json:"structType,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ArrayElementType") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ArrayElementType") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

Type: `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.

func (*Type) MarshalJSON Uses

func (s *Type) MarshalJSON() ([]byte, error)

type UpdateDatabaseDdlMetadata Uses

type UpdateDatabaseDdlMetadata struct {
    // CommitTimestamps: Reports the commit timestamps of all statements
    // that have
    // succeeded so far, where `commit_timestamps[i]` is the
    // commit
    // timestamp for the statement `statements[i]`.
    CommitTimestamps []string `json:"commitTimestamps,omitempty"`

    // Database: The database being modified.
    Database string `json:"database,omitempty"`

    // Statements: For an update this list contains all the statements. For
    // an
    // individual statement, this list contains only that statement.
    Statements []string `json:"statements,omitempty"`

    // ForceSendFields is a list of field names (e.g. "CommitTimestamps") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CommitTimestamps") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

UpdateDatabaseDdlMetadata: Metadata type for the operation returned by UpdateDatabaseDdl.

func (*UpdateDatabaseDdlMetadata) MarshalJSON Uses

func (s *UpdateDatabaseDdlMetadata) MarshalJSON() ([]byte, error)

type UpdateDatabaseDdlRequest Uses

type UpdateDatabaseDdlRequest struct {
    // OperationId: If empty, the new update request is assigned
    // an
    // automatically-generated operation ID. Otherwise, `operation_id`
    // is used to construct the name of the resulting
    // Operation.
    //
    // Specifying an explicit operation ID simplifies determining
    // whether the statements were executed in the event that
    // the
    // UpdateDatabaseDdl call is replayed,
    // or the return value is otherwise lost: the database
    // and
    // `operation_id` fields can be combined to form the
    // name of the resulting
    // longrunning.Operation:
    // `<database>/operations/<operation_id>`.
    //
    // `operation_id` should be unique within the database, and must be
    // a valid identifier: `a-z*`. Note that
    // automatically-generated operation IDs always begin with
    // an
    // underscore. If the named operation already exists,
    // UpdateDatabaseDdl returns
    // `ALREADY_EXISTS`.
    OperationId string `json:"operationId,omitempty"`

    // Statements: DDL statements to be applied to the database.
    Statements []string `json:"statements,omitempty"`

    // ForceSendFields is a list of field names (e.g. "OperationId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "OperationId") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

UpdateDatabaseDdlRequest: Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled.

Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details.

func (*UpdateDatabaseDdlRequest) MarshalJSON Uses

func (s *UpdateDatabaseDdlRequest) MarshalJSON() ([]byte, error)

type UpdateInstanceMetadata Uses

type UpdateInstanceMetadata struct {
    // CancelTime: The time at which this operation was cancelled. If set,
    // this operation is
    // in the process of undoing itself (which is guaranteed to succeed)
    // and
    // cannot be cancelled again.
    CancelTime string `json:"cancelTime,omitempty"`

    // EndTime: The time at which this operation failed or was completed
    // successfully.
    EndTime string `json:"endTime,omitempty"`

    // Instance: The desired end state of the update.
    Instance *Instance `json:"instance,omitempty"`

    // StartTime: The time at which UpdateInstance
    // request was received.
    StartTime string `json:"startTime,omitempty"`

    // ForceSendFields is a list of field names (e.g. "CancelTime") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CancelTime") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

UpdateInstanceMetadata: Metadata type for the operation returned by UpdateInstance.

func (*UpdateInstanceMetadata) MarshalJSON Uses

func (s *UpdateInstanceMetadata) MarshalJSON() ([]byte, error)

type UpdateInstanceRequest Uses

type UpdateInstanceRequest struct {
    // FieldMask: Required. A mask specifying which fields in
    // [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance]
    // should be updated.
    // The field mask must always be specified; this prevents any future
    // fields in
    // [][google.spanner.admin.instance.v1.Instance] from being erased
    // accidentally by clients that do not know
    // about them.
    FieldMask string `json:"fieldMask,omitempty"`

    // Instance: Required. The instance to update, which must always include
    // the instance
    // name.  Otherwise, only fields mentioned in
    // [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask]
    // need be included.
    Instance *Instance `json:"instance,omitempty"`

    // ForceSendFields is a list of field names (e.g. "FieldMask") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "FieldMask") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

UpdateInstanceRequest: The request for UpdateInstance.

func (*UpdateInstanceRequest) MarshalJSON Uses

func (s *UpdateInstanceRequest) MarshalJSON() ([]byte, error)

type Write Uses

type Write struct {
    // Columns: The names of the columns in table to be written.
    //
    // The list of columns must contain enough columns to allow
    // Cloud Spanner to derive values for all primary key columns in
    // the
    // row(s) to be modified.
    Columns []string `json:"columns,omitempty"`

    // Table: Required. The table whose rows will be written.
    Table string `json:"table,omitempty"`

    // Values: The values to be written. `values` can contain more than
    // one
    // list of values. If it does, then multiple rows are written, one
    // for each entry in `values`. Each list in `values` must have
    // exactly as many entries as there are entries in columns
    // above. Sending multiple lists is equivalent to sending
    // multiple
    // `Mutation`s, each containing one `values` entry and repeating
    // table and columns. Individual values in each list are
    // encoded as described here.
    Values [][]interface{} `json:"values,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Columns") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Columns") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Write: Arguments to insert, update, insert_or_update, and replace operations.

func (*Write) MarshalJSON Uses

func (s *Write) MarshalJSON() ([]byte, error)

Package spanner imports 14 packages (graph) and is imported by 4 packages. Updated 2019-07-21. Refresh now. Tools for package owners.