Class: Google::Area120::Tables::V1alpha1::TablesService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb

Overview

REST client for the TablesService service.

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

  • The API has a collection of Table resources, named tables/*

  • Each Table has a collection of Row resources, named tables/*/rows/*

  • The API has a collection of Workspace resources, named workspaces/*.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#row_path, #table_path, #workspace_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new TablesService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the TablesService client.

Yield Parameters:



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 166

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @tables_service_stub = ::Google::Area120::Tables::V1alpha1::TablesService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the TablesService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all TablesService clients
::Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 75

def self.configure
  @configure ||= begin
    namespace = ["Google", "Area120", "Tables", "V1alpha1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_table.timeout = 60.0

    default_config.rpcs.list_tables.timeout = 60.0

    default_config.rpcs.get_workspace.timeout = 60.0

    default_config.rpcs.list_workspaces.timeout = 60.0

    default_config.rpcs.get_row.timeout = 60.0

    default_config.rpcs.list_rows.timeout = 60.0

    default_config.rpcs.create_row.timeout = 60.0

    default_config.rpcs.batch_create_rows.timeout = 60.0

    default_config.rpcs.update_row.timeout = 60.0

    default_config.rpcs.batch_update_rows.timeout = 60.0

    default_config.rpcs.delete_row.timeout = 60.0

    default_config.rpcs.batch_delete_rows.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#batch_create_rows(request, options = nil) ⇒ ::Google::Area120::Tables::V1alpha1::BatchCreateRowsResponse #batch_create_rows(parent: nil, requests: nil) ⇒ ::Google::Area120::Tables::V1alpha1::BatchCreateRowsResponse

Creates multiple rows.

Examples:

Basic example

require "google/area120/tables/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Area120::Tables::V1alpha1::BatchCreateRowsRequest.new

# Call the batch_create_rows method.
result = client.batch_create_rows request

# The returned object is of type Google::Area120::Tables::V1alpha1::BatchCreateRowsResponse.
p result

Overloads:

  • #batch_create_rows(request, options = nil) ⇒ ::Google::Area120::Tables::V1alpha1::BatchCreateRowsResponse

    Pass arguments to batch_create_rows via a request object, either of type BatchCreateRowsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Area120::Tables::V1alpha1::BatchCreateRowsRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #batch_create_rows(parent: nil, requests: nil) ⇒ ::Google::Area120::Tables::V1alpha1::BatchCreateRowsResponse

    Pass arguments to batch_create_rows via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil)

      Required. The parent table where the rows will be created. Format: tables/{table}

    • requests (::Array<::Google::Area120::Tables::V1alpha1::CreateRowRequest, ::Hash>) (defaults to: nil)

      Required. The request message specifying the rows to create.

      A maximum of 500 rows can be created in a single batch.

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the REST call is aborted.



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 867

def batch_create_rows request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Area120::Tables::V1alpha1::BatchCreateRowsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.batch_create_rows..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Area120::Tables::V1alpha1::VERSION,
    transports_version_send: [:rest]

  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_create_rows.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.batch_create_rows.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @tables_service_stub.batch_create_rows request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_delete_rows(request, options = nil) ⇒ ::Google::Protobuf::Empty #batch_delete_rows(parent: nil, names: nil) ⇒ ::Google::Protobuf::Empty

Deletes multiple rows.

Examples:

Basic example

require "google/area120/tables/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Area120::Tables::V1alpha1::BatchDeleteRowsRequest.new

# Call the batch_delete_rows method.
result = client.batch_delete_rows request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #batch_delete_rows(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to batch_delete_rows via a request object, either of type BatchDeleteRowsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Area120::Tables::V1alpha1::BatchDeleteRowsRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #batch_delete_rows(parent: nil, names: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to batch_delete_rows via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil)

      Required. The parent table shared by all rows being deleted. Format: tables/{table}

    • names (::Array<::String>) (defaults to: nil)

      Required. The names of the rows to delete. All rows must belong to the parent table or else the entire batch will fail. A maximum of 500 rows can be deleted in a batch. Format: tables/{table}/rows/{row}

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the REST call is aborted.



1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 1200

def batch_delete_rows request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Area120::Tables::V1alpha1::BatchDeleteRowsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.batch_delete_rows..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Area120::Tables::V1alpha1::VERSION,
    transports_version_send: [:rest]

  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_delete_rows.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.batch_delete_rows.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @tables_service_stub.batch_delete_rows request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_update_rows(request, options = nil) ⇒ ::Google::Area120::Tables::V1alpha1::BatchUpdateRowsResponse #batch_update_rows(parent: nil, requests: nil) ⇒ ::Google::Area120::Tables::V1alpha1::BatchUpdateRowsResponse

Updates multiple rows.

Examples:

Basic example

require "google/area120/tables/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Area120::Tables::V1alpha1::BatchUpdateRowsRequest.new

# Call the batch_update_rows method.
result = client.batch_update_rows request

# The returned object is of type Google::Area120::Tables::V1alpha1::BatchUpdateRowsResponse.
p result

Overloads:

  • #batch_update_rows(request, options = nil) ⇒ ::Google::Area120::Tables::V1alpha1::BatchUpdateRowsResponse

    Pass arguments to batch_update_rows via a request object, either of type BatchUpdateRowsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Area120::Tables::V1alpha1::BatchUpdateRowsRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #batch_update_rows(parent: nil, requests: nil) ⇒ ::Google::Area120::Tables::V1alpha1::BatchUpdateRowsResponse

    Pass arguments to batch_update_rows via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil)

      Required. The parent table shared by all rows being updated. Format: tables/{table}

    • requests (::Array<::Google::Area120::Tables::V1alpha1::UpdateRowRequest, ::Hash>) (defaults to: nil)

      Required. The request messages specifying the rows to update.

      A maximum of 500 rows can be modified in a single batch.

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the REST call is aborted.



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 1035

def batch_update_rows request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Area120::Tables::V1alpha1::BatchUpdateRowsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.batch_update_rows..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Area120::Tables::V1alpha1::VERSION,
    transports_version_send: [:rest]

  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_update_rows.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.batch_update_rows.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @tables_service_stub.batch_update_rows request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the TablesService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



136
137
138
139
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 136

def configure
  yield @config if block_given?
  @config
end

#create_row(request, options = nil) ⇒ ::Google::Area120::Tables::V1alpha1::Row #create_row(parent: nil, row: nil, view: nil) ⇒ ::Google::Area120::Tables::V1alpha1::Row

Creates a row.

Examples:

Basic example

require "google/area120/tables/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Area120::Tables::V1alpha1::CreateRowRequest.new

# Call the create_row method.
result = client.create_row request

# The returned object is of type Google::Area120::Tables::V1alpha1::Row.
p result

Overloads:

  • #create_row(request, options = nil) ⇒ ::Google::Area120::Tables::V1alpha1::Row

    Pass arguments to create_row via a request object, either of type CreateRowRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Area120::Tables::V1alpha1::CreateRowRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_row(parent: nil, row: nil, view: nil) ⇒ ::Google::Area120::Tables::V1alpha1::Row

    Pass arguments to create_row via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the REST call is aborted.



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 783

def create_row request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Area120::Tables::V1alpha1::CreateRowRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.create_row..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Area120::Tables::V1alpha1::VERSION,
    transports_version_send: [:rest]

  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_row.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.create_row.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @tables_service_stub.create_row request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_row(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_row(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a row.

Examples:

Basic example

require "google/area120/tables/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Area120::Tables::V1alpha1::DeleteRowRequest.new

# Call the delete_row method.
result = client.delete_row request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_row(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_row via a request object, either of type DeleteRowRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Area120::Tables::V1alpha1::DeleteRowRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_row(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_row via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil)

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

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the REST call is aborted.



1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 1115

def delete_row request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Area120::Tables::V1alpha1::DeleteRowRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.delete_row..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Area120::Tables::V1alpha1::VERSION,
    transports_version_send: [:rest]

  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_row.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.delete_row.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @tables_service_stub.delete_row request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_row(request, options = nil) ⇒ ::Google::Area120::Tables::V1alpha1::Row #get_row(name: nil, view: nil) ⇒ ::Google::Area120::Tables::V1alpha1::Row

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

Examples:

Basic example

require "google/area120/tables/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Area120::Tables::V1alpha1::GetRowRequest.new

# Call the get_row method.
result = client.get_row request

# The returned object is of type Google::Area120::Tables::V1alpha1::Row.
p result

Overloads:

  • #get_row(request, options = nil) ⇒ ::Google::Area120::Tables::V1alpha1::Row

    Pass arguments to get_row via a request object, either of type GetRowRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Area120::Tables::V1alpha1::GetRowRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_row(name: nil, view: nil) ⇒ ::Google::Area120::Tables::V1alpha1::Row

    Pass arguments to get_row via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil)

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

    • view (::Google::Area120::Tables::V1alpha1::View) (defaults to: nil)

      Optional. Column key to use for values in the row. Defaults to user entered name.

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the REST call is aborted.



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 594

def get_row request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Area120::Tables::V1alpha1::GetRowRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.get_row..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Area120::Tables::V1alpha1::VERSION,
    transports_version_send: [:rest]

  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_row.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.get_row.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @tables_service_stub.get_row request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_table(request, options = nil) ⇒ ::Google::Area120::Tables::V1alpha1::Table #get_table(name: nil) ⇒ ::Google::Area120::Tables::V1alpha1::Table

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

Examples:

Basic example

require "google/area120/tables/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Area120::Tables::V1alpha1::GetTableRequest.new

# Call the get_table method.
result = client.get_table request

# The returned object is of type Google::Area120::Tables::V1alpha1::Table.
p result

Overloads:

  • #get_table(request, options = nil) ⇒ ::Google::Area120::Tables::V1alpha1::Table

    Pass arguments to get_table via a request object, either of type GetTableRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Area120::Tables::V1alpha1::GetTableRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_table(name: nil) ⇒ ::Google::Area120::Tables::V1alpha1::Table

    Pass arguments to get_table via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil)

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

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the REST call is aborted.



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 243

def get_table request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Area120::Tables::V1alpha1::GetTableRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.get_table..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Area120::Tables::V1alpha1::VERSION,
    transports_version_send: [:rest]

  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_table.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.get_table.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @tables_service_stub.get_table request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_workspace(request, options = nil) ⇒ ::Google::Area120::Tables::V1alpha1::Workspace #get_workspace(name: nil) ⇒ ::Google::Area120::Tables::V1alpha1::Workspace

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

Examples:

Basic example

require "google/area120/tables/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Area120::Tables::V1alpha1::GetWorkspaceRequest.new

# Call the get_workspace method.
result = client.get_workspace request

# The returned object is of type Google::Area120::Tables::V1alpha1::Workspace.
p result

Overloads:

  • #get_workspace(request, options = nil) ⇒ ::Google::Area120::Tables::V1alpha1::Workspace

    Pass arguments to get_workspace via a request object, either of type GetWorkspaceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Area120::Tables::V1alpha1::GetWorkspaceRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_workspace(name: nil) ⇒ ::Google::Area120::Tables::V1alpha1::Workspace

    Pass arguments to get_workspace via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil)

      Required. The name of the workspace to retrieve. Format: workspaces/{workspace}

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the REST call is aborted.



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 417

def get_workspace request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Area120::Tables::V1alpha1::GetWorkspaceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.get_workspace..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Area120::Tables::V1alpha1::VERSION,
    transports_version_send: [:rest]

  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_workspace.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.get_workspace.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @tables_service_stub.get_workspace request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_rows(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Row> #list_rows(parent: nil, page_size: nil, page_token: nil, view: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Row>

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

Examples:

Basic example

require "google/area120/tables/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Area120::Tables::V1alpha1::ListRowsRequest.new

# Call the list_rows method.
result = client.list_rows request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Area120::Tables::V1alpha1::Row.
  p item
end

Overloads:

  • #list_rows(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Row>

    Pass arguments to list_rows via a request object, either of type ListRowsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Area120::Tables::V1alpha1::ListRowsRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_rows(parent: nil, page_size: nil, page_token: nil, view: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Row>

    Pass arguments to list_rows via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil)

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

    • page_size (::Integer) (defaults to: nil)

      The maximum number of rows to return. The service may return fewer than this value.

      If unspecified, at most 50 rows are returned. The maximum value is 1,000; values above 1,000 are coerced to 1,000.

    • page_token (::String) (defaults to: nil)

      A page token, received from a previous ListRows call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListRows must match the call that provided the page token.

    • view (::Google::Area120::Tables::V1alpha1::View) (defaults to: nil)

      Optional. Column key to use for values in the row. Defaults to user entered name.

    • filter (::String) (defaults to: nil)

      Optional. Raw text query to search for in rows of the table. Special characters must be escaped. Logical operators and field specific filtering not supported.

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the REST call is aborted.



697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 697

def list_rows request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Area120::Tables::V1alpha1::ListRowsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.list_rows..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Area120::Tables::V1alpha1::VERSION,
    transports_version_send: [:rest]

  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_rows.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.list_rows.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @tables_service_stub.list_rows request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @tables_service_stub, :list_rows, "rows", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_tables(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Table> #list_tables(page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Table>

Lists tables for the user.

Examples:

Basic example

require "google/area120/tables/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Area120::Tables::V1alpha1::ListTablesRequest.new

# Call the list_tables method.
result = client.list_tables request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Area120::Tables::V1alpha1::Table.
  p item
end

Overloads:

  • #list_tables(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Table>

    Pass arguments to list_tables via a request object, either of type ListTablesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Area120::Tables::V1alpha1::ListTablesRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_tables(page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Table>

    Pass arguments to list_tables via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • page_size (::Integer) (defaults to: nil)

      The maximum number of tables to return. The service may return fewer than this value.

      If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100.

    • page_token (::String) (defaults to: nil)

      A page token, received from a previous ListTables call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListTables must match the call that provided the page token.

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the REST call is aborted.



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 336

def list_tables request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Area120::Tables::V1alpha1::ListTablesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.list_tables..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Area120::Tables::V1alpha1::VERSION,
    transports_version_send: [:rest]

  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_tables.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.list_tables.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @tables_service_stub.list_tables request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @tables_service_stub, :list_tables, "tables", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_workspaces(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Workspace> #list_workspaces(page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Workspace>

Lists workspaces for the user.

Examples:

Basic example

require "google/area120/tables/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Area120::Tables::V1alpha1::ListWorkspacesRequest.new

# Call the list_workspaces method.
result = client.list_workspaces request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Area120::Tables::V1alpha1::Workspace.
  p item
end

Overloads:

  • #list_workspaces(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Workspace>

    Pass arguments to list_workspaces via a request object, either of type ListWorkspacesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Area120::Tables::V1alpha1::ListWorkspacesRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_workspaces(page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Workspace>

    Pass arguments to list_workspaces via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • page_size (::Integer) (defaults to: nil)

      The maximum number of workspaces to return. The service may return fewer than this value.

      If unspecified, at most 10 workspaces are returned. The maximum value is 25; values above 25 are coerced to 25.

    • page_token (::String) (defaults to: nil)

      A page token, received from a previous ListWorkspaces call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListWorkspaces must match the call that provided the page token.

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the REST call is aborted.



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 510

def list_workspaces request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Area120::Tables::V1alpha1::ListWorkspacesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.list_workspaces..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Area120::Tables::V1alpha1::VERSION,
    transports_version_send: [:rest]

  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_workspaces.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.list_workspaces.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @tables_service_stub.list_workspaces request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @tables_service_stub, :list_workspaces, "workspaces", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domainString

The effective universe domain

Returns:

  • (String)


146
147
148
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 146

def universe_domain
  @tables_service_stub.universe_domain
end

#update_row(request, options = nil) ⇒ ::Google::Area120::Tables::V1alpha1::Row #update_row(row: nil, update_mask: nil, view: nil) ⇒ ::Google::Area120::Tables::V1alpha1::Row

Updates a row.

Examples:

Basic example

require "google/area120/tables/v1alpha1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Area120::Tables::V1alpha1::UpdateRowRequest.new

# Call the update_row method.
result = client.update_row request

# The returned object is of type Google::Area120::Tables::V1alpha1::Row.
p result

Overloads:

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the REST call is aborted.



951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
# File 'lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb', line 951

def update_row request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Area120::Tables::V1alpha1::UpdateRowRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.update_row..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Area120::Tables::V1alpha1::VERSION,
    transports_version_send: [:rest]

  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_row.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.update_row.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @tables_service_stub.update_row request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end