Class: Google::Apps::Chat::V1::ChatService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/apps/chat/v1/chat_service/rest/client.rb

Overview

REST client for the ChatService service.

Enables developers to build Chat apps and integrations on Google Chat Platform.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#attachment_path, #availability_path, #custom_emoji_path, #membership_path, #message_path, #quoted_message_metadata_path, #reaction_path, #section_item_path, #section_path, #space_event_path, #space_notification_setting_path, #space_path, #space_read_state_path, #thread_path, #thread_read_state_path, #user_path

Constructor Details

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

Create a new ChatService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Apps::Chat::V1::ChatService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ChatService client.

Yield Parameters:



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 372

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

  @chat_service_stub = ::Google::Apps::Chat::V1::ChatService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @chat_service_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Class Method Details

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

Configure the ChatService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ChatService clients
::Google::Apps::Chat::V1::ChatService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



65
66
67
68
69
70
71
72
73
74
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Apps", "Chat", "V1"]
    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.rpcs.create_message.timeout = 30.0
    default_config.rpcs.create_message.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#complete_import_space(request, options = nil) ⇒ ::Google::Apps::Chat::V1::CompleteImportSpaceResponse #complete_import_space(name: nil) ⇒ ::Google::Apps::Chat::V1::CompleteImportSpaceResponse

Completes the import process for the specified space and makes it visible to users.

Requires user authentication and domain-wide delegation with the authorization scope:

  • https://www.googleapis.com/auth/chat.import

For more information, see Authorize Google Chat apps to import data.

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::CompleteImportSpaceRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::CompleteImportSpaceResponse.
p result

Overloads:

  • #complete_import_space(request, options = nil) ⇒ ::Google::Apps::Chat::V1::CompleteImportSpaceResponse

    Pass arguments to complete_import_space via a request object, either of type Google::Apps::Chat::V1::CompleteImportSpaceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Chat::V1::CompleteImportSpaceRequest, ::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.

  • #complete_import_space(name: nil) ⇒ ::Google::Apps::Chat::V1::CompleteImportSpaceResponse

    Pass arguments to complete_import_space 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. Resource name of the import mode space.

      Format: spaces/{space}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 3099

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::CompleteImportSpaceRequest

  # 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
  call_metadata = @config.rpcs.complete_import_space.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.complete_import_space.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.complete_import_space.retry_policy

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

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

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

Configure the ChatService 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:



342
343
344
345
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 342

def configure
  yield @config if block_given?
  @config
end

#create_custom_emoji(request, options = nil) ⇒ ::Google::Apps::Chat::V1::CustomEmoji #create_custom_emoji(custom_emoji: nil) ⇒ ::Google::Apps::Chat::V1::CustomEmoji

Creates a custom emoji.

Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions.

Requires user authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.customemojis

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::CreateCustomEmojiRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::CustomEmoji.
p result

Overloads:

  • #create_custom_emoji(request, options = nil) ⇒ ::Google::Apps::Chat::V1::CustomEmoji

    Pass arguments to create_custom_emoji via a request object, either of type Google::Apps::Chat::V1::CreateCustomEmojiRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Chat::V1::CreateCustomEmojiRequest, ::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_custom_emoji(custom_emoji: nil) ⇒ ::Google::Apps::Chat::V1::CustomEmoji

    Pass arguments to create_custom_emoji 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.



4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 4223

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::CreateCustomEmojiRequest

  # 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
  call_metadata = @config.rpcs.create_custom_emoji.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.create_custom_emoji.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_custom_emoji.retry_policy

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

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

#create_membership(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Membership #create_membership(parent: nil, membership: nil, use_admin_access: nil) ⇒ ::Google::Apps::Chat::V1::Membership

Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space.

Supports the following types of authentication:

  • App authentication with administrator approval and the authorization scope:

    • https://www.googleapis.com/auth/chat.app.memberships

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (to add the calling app to the space)
    • https://www.googleapis.com/auth/chat.import (import mode spaces only)
    • User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true, and the following authorization scope is used:
      • https://www.googleapis.com/auth/chat.admin.memberships

App authentication is not supported for the following use cases:

  • Inviting users external to the Workspace organization that owns the space.
  • Adding a Google Group to a space.
  • Adding a Chat app to a space.

For example usage, see:

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::CreateMembershipRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Membership.
p result

Overloads:

  • #create_membership(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Membership

    Pass arguments to create_membership via a request object, either of type Google::Apps::Chat::V1::CreateMembershipRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Chat::V1::CreateMembershipRequest, ::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_membership(parent: nil, membership: nil, use_admin_access: nil) ⇒ ::Google::Apps::Chat::V1::Membership

    Pass arguments to create_membership 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 resource name of the space for which to create the membership.

      Format: spaces/{space}

    • membership (::Google::Apps::Chat::V1::Membership, ::Hash) (defaults to: nil) —

      Required. The membership relation to create.

      The memberType field must contain a user with the user.name and user.type fields populated. The server will assign a resource name and overwrite anything specified.

      When a Chat app creates a membership relation for a human user, it must use certain authorization scopes and set specific values for certain fields:

      • When authenticating as a user, the chat.memberships authorization scope is required.

      • When authenticating as an app, the chat.app.memberships authorization scope is required.

      • Set user.type to HUMAN, and set user.name with format users/{user}, where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id of the person from the People API, or the id for the user in the Directory API. For example, if the People API Person profile ID for user@example.com is 123456789, you can add the user to the space by setting the membership.member.name to users/user@example.com or users/123456789.

      Inviting users external to the Workspace organization that owns the space requires user authentication.

      When a Chat app creates a membership relation for itself, it must authenticate as a user and use the chat.memberships.app scope, set user.type to BOT, and set user.name to users/app.

    • use_admin_access (::Boolean) (defaults to: nil) —

      Optional. When true, the method runs using the user's Google Workspace administrator privileges.

      The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

      Requires the chat.admin.memberships OAuth 2.0 scope.

      Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 3532

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::CreateMembershipRequest

  # 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
  call_metadata = @config.rpcs.create_membership.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.create_membership.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_membership.retry_policy

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

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

#create_message(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Message #create_message(parent: nil, message: nil, thread_key: nil, request_id: nil, message_reply_option: nil, message_id: nil, create_message_notification_options: nil) ⇒ ::Google::Apps::Chat::V1::Message

Creates a message in a Google Chat space. For an example, see Send a message.

Supports the following types of authentication:

  • App authentication with the authorization scope:
    • https://www.googleapis.com/auth/chat.bot
  • User authentication with one of the following authorization scopes:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (import mode spaces only)

Chat attributes the message sender differently depending on the type of authentication that you use in your request.

The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text (text), cards (cardsV2), and accessory widgets (accessoryWidgets).

Message sent with app authentication

The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text (text).

Message sent with user authentication

The maximum message size, including the message contents, is 32,000 bytes.

For webhook requests, the response doesn't contain the full message. The response only populates the name and thread.name fields in addition to the information that was in the request.

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::CreateMessageRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Message.
p result

Overloads:

  • #create_message(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Message

    Pass arguments to create_message via a request object, either of type Google::Apps::Chat::V1::CreateMessageRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Chat::V1::CreateMessageRequest, ::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_message(parent: nil, message: nil, thread_key: nil, request_id: nil, message_reply_option: nil, message_id: nil, create_message_notification_options: nil) ⇒ ::Google::Apps::Chat::V1::Message

    Pass arguments to create_message 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 resource name of the space in which to create a message.

      Format: spaces/{space}

    • message (::Google::Apps::Chat::V1::Message, ::Hash) (defaults to: nil) —

      Required. Message body.

    • thread_key (::String) (defaults to: nil) —

      Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a threadKey or the thread.name. For example usage, see Start or reply to a message thread.

    • request_id (::String) (defaults to: nil) —

      Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message.

    • message_reply_option (::Google::Apps::Chat::V1::CreateMessageRequest::MessageReplyOption) (defaults to: nil) —

      Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.

      When responding to user interactions, this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.

    • message_id (::String) (defaults to: nil) —

      Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message name field).

      The value for this field must meet the following requirements:

      • Begins with client-. For example, client-custom-name is a valid custom ID, but custom-name is not.
      • Contains up to 63 characters and only lowercase letters, numbers, and hyphens.
      • Is unique within a space. A Chat app can't use the same custom ID for different messages.

      For details, see Name a message.

    • create_message_notification_options (::Google::Apps::Chat::V1::CreateMessageNotificationOptions, ::Hash) (defaults to: nil) —

      Optional. Controls the notification behavior when the message is posted. To learn more, see Force notifications or send silent messages.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 556

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::CreateMessageRequest

  # 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
  call_metadata = @config.rpcs.create_message.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.create_message.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_message.retry_policy

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

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

#create_reaction(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Reaction #create_reaction(parent: nil, reaction: nil) ⇒ ::Google::Apps::Chat::V1::Reaction

Creates a reaction and adds it to a message. For an example, see Add a reaction to a message.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (import mode spaces only)

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::CreateReactionRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Reaction.
p result

Overloads:

  • #create_reaction(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Reaction

    Pass arguments to create_reaction via a request object, either of type Google::Apps::Chat::V1::CreateReactionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Chat::V1::CreateReactionRequest, ::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_reaction(parent: nil, reaction: nil) ⇒ ::Google::Apps::Chat::V1::Reaction

    Pass arguments to create_reaction 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 message where the reaction is created.

      Format: spaces/{space}/messages/{message}

    • reaction (::Google::Apps::Chat::V1::Reaction, ::Hash) (defaults to: nil) —

      Required. The reaction to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 3886

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::CreateReactionRequest

  # 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
  call_metadata = @config.rpcs.create_reaction.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.create_reaction.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_reaction.retry_policy

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

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

#create_section(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Section #create_section(parent: nil, section: nil) ⇒ ::Google::Apps::Chat::V1::Section

Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type CUSTOM_SECTION can be created. For details, see Create and organize sections in Google Chat.

Requires user authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.users.sections

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::CreateSectionRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Section.
p result

Overloads:

  • #create_section(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Section

    Pass arguments to create_section via a request object, either of type Google::Apps::Chat::V1::CreateSectionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Chat::V1::CreateSectionRequest, ::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_section(parent: nil, section: nil) ⇒ ::Google::Apps::Chat::V1::Section

    Pass arguments to create_section 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 resource name where the section is created.

      Format: users/{user}

    • section (::Google::Apps::Chat::V1::Section, ::Hash) (defaults to: nil) —

      Required. The section to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 5971

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::CreateSectionRequest

  # 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
  call_metadata = @config.rpcs.create_section.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.create_section.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_section.retry_policy

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

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

#create_space(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Space #create_space(space: nil, request_id: nil) ⇒ ::Google::Apps::Chat::V1::Space

Creates a space. Can be used to create a named space, or a group chat in Import mode. For an example, see Create a space.

Supports the following types of authentication:

  • App authentication with administrator approval and one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.app.spaces.create
    • https://www.googleapis.com/auth/chat.app.spaces

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (import mode spaces only)

When authenticating as an app, the space.customer field must be set in the request.

When authenticating as an app, the Chat app is added as a member of the space. However, unlike human authentication, the Chat app is not added as a space manager. By default, the Chat app can be removed from the space by all space members. To allow only space managers to remove the app from a space, set space.permission_settings.manage_apps to managers_allowed.

Space membership upon creation depends on whether the space is created in Import mode:

  • Import mode: No members are created.
  • All other modes: The calling user is added as a member. This is:
    • The app itself when using app authentication.
    • The human user when using user authentication.

If you receive the error message ALREADY_EXISTS when creating a space, try a different displayName. An existing space within the Google Workspace organization might already use this display name.

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::CreateSpaceRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Space.
p result

Overloads:

  • #create_space(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Space

    Pass arguments to create_space via a request object, either of type Google::Apps::Chat::V1::CreateSpaceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Chat::V1::CreateSpaceRequest, ::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_space(space: nil, request_id: nil) ⇒ ::Google::Apps::Chat::V1::Space

    Pass arguments to create_space 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:

    • space (::Google::Apps::Chat::V1::Space, ::Hash) (defaults to: nil) —

      Required. The displayName and spaceType fields must be populated. Only SpaceType.SPACE and SpaceType.GROUP_CHAT are supported. SpaceType.GROUP_CHAT can only be used if importMode is set to true.

      If you receive the error message ALREADY_EXISTS, try a different displayName. An existing space within the Google Workspace organization might already use this display name.

      The space name is assigned on the server so anything specified in this field will be ignored.

    • request_id (::String) (defaults to: nil) —

      Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 2490

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::CreateSpaceRequest

  # 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
  call_metadata = @config.rpcs.create_space.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.create_space.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_space.retry_policy

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

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

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

Deletes a custom emoji. By default, users can only delete custom emoji they created. Emoji managers assigned by the administrator can delete any custom emoji in the organization. See Learn about custom emojis in Google Chat.

Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions.

Requires user authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.customemojis

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::DeleteCustomEmojiRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Apps::Chat::V1::DeleteCustomEmojiRequest, ::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_custom_emoji(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_custom_emoji 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. Resource name of the custom emoji to delete.

      Format: customEmojis/{customEmoji}

      You can use the emoji name as an alias for {customEmoji}. For example, customEmojis/:example-emoji: where :example-emoji: is the emoji name for a custom emoji.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 4549

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::DeleteCustomEmojiRequest

  # 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
  call_metadata = @config.rpcs.delete_custom_emoji.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.delete_custom_emoji.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_custom_emoji.retry_policy

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

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

#delete_membership(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Membership #delete_membership(name: nil, use_admin_access: nil) ⇒ ::Google::Apps::Chat::V1::Membership

Deletes a membership. For an example, see Remove a user or a Google Chat app from a space.

Supports the following types of authentication:

  • App authentication with administrator approval and the authorization scope:

    • https://www.googleapis.com/auth/chat.app.memberships

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (to remove the calling app from the space)
    • https://www.googleapis.com/auth/chat.import (import mode spaces only)
    • User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true, and the following authorization scope is used:
      • https://www.googleapis.com/auth/chat.admin.memberships

App authentication is not supported for the following use cases:

  • Removing a Google Group from a space.
  • Removing a Chat app from a space.

To delete memberships for space managers, the requester must be a space manager. If you're using app authentication the Chat app must be the space creator.

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::DeleteMembershipRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Membership.
p result

Overloads:

  • #delete_membership(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Membership

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

    Parameters:

    • request (::Google::Apps::Chat::V1::DeleteMembershipRequest, ::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_membership(name: nil, use_admin_access: nil) ⇒ ::Google::Apps::Chat::V1::Membership

    Pass arguments to delete_membership 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. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships.

      When deleting a human membership, requires the chat.memberships scope with user authentication or the chat.memberships.app scope with app authentication and the spaces/{space}/members/{member} format. You can use the email as an alias for {member}. For example, spaces/{space}/members/example@gmail.com where example@gmail.com is the email of the Google Chat user.

      When deleting an app membership, requires the chat.memberships.app scope and spaces/{space}/members/app format.

      Format: spaces/{space}/members/{member} or spaces/{space}/members/app.

    • use_admin_access (::Boolean) (defaults to: nil) —

      Optional. When true, the method runs using the user's Google Workspace administrator privileges.

      The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

      Requires the chat.admin.memberships OAuth 2.0 scope.

      Deleting app memberships in a space isn't supported using admin access.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 3792

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::DeleteMembershipRequest

  # 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
  call_metadata = @config.rpcs.delete_membership.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.delete_membership.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_membership.retry_policy

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

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

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

Deletes a message. For an example, see Delete a message.

Supports the following types of authentication:

  • App authentication with the authorization scope:

    • https://www.googleapis.com/auth/chat.bot

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (import mode spaces only)

When using app authentication, requests can only delete messages created by the calling Chat app.

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::DeleteMessageRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Apps::Chat::V1::DeleteMessageRequest, ::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_message(name: nil, force: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_message 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. Resource name of the message.

      Format: spaces/{space}/messages/{message}

      If you've set a custom ID for your message, you can use the value from the clientAssignedMessageId field for {message}. For details, see Name a message.

    • force (::Boolean) (defaults to: nil) —

      Optional. When true, deleting a message also deletes its threaded replies. When false, if a message has threaded replies, deletion fails.

      Only applies when authenticating as a user. Has no effect when authenticating as a Chat app.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 1417

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::DeleteMessageRequest

  # 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
  call_metadata = @config.rpcs.delete_message.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.delete_message.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_message.retry_policy

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

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

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

Deletes a reaction to a message. For an example, see Delete a reaction.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (import mode spaces only)

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::DeleteReactionRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Apps::Chat::V1::DeleteReactionRequest, ::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_reaction(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_reaction 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. Name of the reaction to delete.

      Format: spaces/{space}/messages/{message}/reactions/{reaction}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 4131

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::DeleteReactionRequest

  # 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
  call_metadata = @config.rpcs.delete_reaction.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.delete_reaction.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_reaction.retry_policy

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

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

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

Deletes a section of type CUSTOM_SECTION.

If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted.

For details, see Create and organize sections in Google Chat.

Requires user authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.users.sections

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::DeleteSectionRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Apps::Chat::V1::DeleteSectionRequest, ::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_section(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_section 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 section to delete.

      Format: users/{user}/sections/{section}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 6064

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::DeleteSectionRequest

  # 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
  call_metadata = @config.rpcs.delete_section.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.delete_section.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_section.retry_policy

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

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

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

Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see Delete a space.

Supports the following types of authentication:

  • App authentication with administrator approval and the authorization scope:

    • https://www.googleapis.com/auth/chat.app.delete (only in spaces the app created)

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.delete
    • https://www.googleapis.com/auth/chat.import (import mode spaces only)
    • User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true, and the following authorization scope is used:
      • https://www.googleapis.com/auth/chat.admin.delete

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::DeleteSpaceRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Apps::Chat::V1::DeleteSpaceRequest, ::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_space(name: nil, use_admin_access: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_space 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. Resource name of the space to delete.

      Format: spaces/{space}

    • use_admin_access (::Boolean) (defaults to: nil) —

      Optional. When true, the method runs using the user's Google Workspace administrator privileges.

      The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

      Requires the chat.admin.delete OAuth 2.0 scope.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 3006

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::DeleteSpaceRequest

  # 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
  call_metadata = @config.rpcs.delete_space.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.delete_space.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_space.retry_policy

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

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

#find_direct_message(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Space #find_direct_message(name: nil) ⇒ ::Google::Apps::Chat::V1::Space

Returns the existing direct message with the specified user. If no direct message space is found, returns a 404 NOT_FOUND error. For an example, see Find a direct message.

With app authentication, returns the direct message space between the specified user and the calling Chat app.

With user authentication, returns the direct message space between the specified user and the authenticated user.

Supports the following types of authentication:

  • App authentication with the authorization scope:

    • https://www.googleapis.com/auth/chat.bot

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::FindDirectMessageRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Space.
p result

Overloads:

  • #find_direct_message(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Space

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

    Parameters:

    • request (::Google::Apps::Chat::V1::FindDirectMessageRequest, ::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.

  • #find_direct_message(name: nil) ⇒ ::Google::Apps::Chat::V1::Space

    Pass arguments to find_direct_message 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. Resource name of the user to find direct message with.

      Format: users/{user}, where {user} is either the id for the person from the People API, or the id for the user in the Directory API. For example, if the People API profile ID is 123456789, you can find a direct message with that person by using users/123456789 as the name. When authenticated as a user, you can use the email as an alias for {user}. For example, users/example@gmail.com where example@gmail.com is the email of the Google Chat user.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 3216

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::FindDirectMessageRequest

  # 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
  call_metadata = @config.rpcs.find_direct_message.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.find_direct_message.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.find_direct_message.retry_policy

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

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

#find_group_chats(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Space> #find_group_chats(users: nil, page_size: nil, page_token: nil, space_view: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Space>

Returns all spaces with spaceType == GROUP_CHAT, whose human memberships contain exactly the calling user, and the users specified in FindGroupChatsRequest.users. Only members that have joined the conversation are supported. For an example, see Find group chats.

If the calling user blocks, or is blocked by, some users, and no spaces with the entire specified set of users are found, this method returns spaces that don't include the blocked or blocking users.

The specified set of users must contain only human (non-app) memberships. A request that contains non-human users doesn't return any spaces.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::FindGroupChatsRequest.new

# Call the find_group_chats method.
result = client.find_group_chats 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::Apps::Chat::V1::Space.
  p item
end

Overloads:

  • #find_group_chats(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Space>

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

    Parameters:

    • request (::Google::Apps::Chat::V1::FindGroupChatsRequest, ::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.

  • #find_group_chats(users: nil, page_size: nil, page_token: nil, space_view: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Space>

    Pass arguments to find_group_chats 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:

    • users (::Array<::String>) (defaults to: nil) —

      Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request.

      The maximum number of users that can be specified in a single request is 49.

      Format: users/{user}, where {user} is either the id for the person from the People API, or the id for the user in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs 123456789 and 987654321, you can use users/123456789 and users/987654321. You can also use the email as an alias for {user}. For example, users/example@gmail.com where example@gmail.com is the email of the Google Chat user.

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

      Optional. The maximum number of spaces to return. The service might return fewer than this value.

      If unspecified, at most 10 spaces are returned.

      The maximum value is 30. If you use a value more than 30, it's automatically changed to 30.

      Negative values return an INVALID_ARGUMENT error.

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

      Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page.

      When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.

    • space_view (::Google::Apps::Chat::V1::SpaceView) (defaults to: nil) —

      Requested space view type. If unset, defaults to SPACE_VIEW_RESOURCE_NAME_ONLY. Requests that specify SPACE_VIEW_EXPANDED must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 3356

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::FindGroupChatsRequest

  # 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
  call_metadata = @config.rpcs.find_group_chats.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.find_group_chats.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.find_group_chats.retry_policy

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

  @chat_service_stub.find_group_chats request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @chat_service_stub, :find_group_chats, "spaces", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_attachment(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Attachment #get_attachment(name: nil) ⇒ ::Google::Apps::Chat::V1::Attachment

Gets the metadata of a message attachment. The attachment data is fetched using the media API. For an example, see Get metadata about a message attachment.

Requires app authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.bot

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::GetAttachmentRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Attachment.
p result

Overloads:

  • #get_attachment(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Attachment

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

    Parameters:

    • request (::Google::Apps::Chat::V1::GetAttachmentRequest, ::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_attachment(name: nil) ⇒ ::Google::Apps::Chat::V1::Attachment

    Pass arguments to get_attachment 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. Resource name of the attachment, in the form spaces/{space}/messages/{message}/attachments/{attachment}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 1781

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::GetAttachmentRequest

  # 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
  call_metadata = @config.rpcs.get_attachment.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.get_attachment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_attachment.retry_policy

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

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

#get_availability(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Availability #get_availability(name: nil) ⇒ ::Google::Apps::Chat::V1::Availability

Returns availability information for a human user in Google Chat. For example, this can be used to check if a user is online or away, or to retrieve their custom status message.

This method only retrieves the authenticated user's availability.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.users.availability.readonly
  • https://www.googleapis.com/auth/chat.users.availability

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::GetAvailabilityRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Availability.
p result

Overloads:

  • #get_availability(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Availability

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

    Parameters:

    • request (::Google::Apps::Chat::V1::GetAvailabilityRequest, ::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_availability(name: nil) ⇒ ::Google::Apps::Chat::V1::Availability

    Pass arguments to get_availability 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 resource name of the availability to retrieve.

      Format: users/{user}/availability

      {user} is the id for the Person in the People API or Admin SDK directory API. For example, users/123456789.

      The user's email address or me can also be used as an alias to refer to the caller. For example, users/user@example.com or users/me.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 4969

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::GetAvailabilityRequest

  # 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
  call_metadata = @config.rpcs.get_availability.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.get_availability.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_availability.retry_policy

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

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

#get_custom_emoji(request, options = nil) ⇒ ::Google::Apps::Chat::V1::CustomEmoji #get_custom_emoji(name: nil) ⇒ ::Google::Apps::Chat::V1::CustomEmoji

Returns details about a custom emoji.

Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::GetCustomEmojiRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::CustomEmoji.
p result

Overloads:

  • #get_custom_emoji(request, options = nil) ⇒ ::Google::Apps::Chat::V1::CustomEmoji

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

    Parameters:

    • request (::Google::Apps::Chat::V1::GetCustomEmojiRequest, ::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_custom_emoji(name: nil) ⇒ ::Google::Apps::Chat::V1::CustomEmoji

    Pass arguments to get_custom_emoji 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. Resource name of the custom emoji.

      Format: customEmojis/{customEmoji}

      You can use the emoji name as an alias for {customEmoji}. For example, customEmojis/:example-emoji: where :example-emoji: is the emoji name for a custom emoji.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 4322

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::GetCustomEmojiRequest

  # 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
  call_metadata = @config.rpcs.get_custom_emoji.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.get_custom_emoji.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_custom_emoji.retry_policy

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

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

#get_membership(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Membership #get_membership(name: nil, use_admin_access: nil) ⇒ ::Google::Apps::Chat::V1::Membership

Returns details about a membership. For an example, see Get details about a user's or Google Chat app's membership.

Supports the following types of authentication:

  • App authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships (requires administrator approval)

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true, and one of the following authorization scopes is used:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::GetMembershipRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Membership.
p result

Overloads:

  • #get_membership(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Membership

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

    Parameters:

    • request (::Google::Apps::Chat::V1::GetMembershipRequest, ::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_membership(name: nil, use_admin_access: nil) ⇒ ::Google::Apps::Chat::V1::Membership

    Pass arguments to get_membership 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. Resource name of the membership to retrieve.

      To get the app's own membership by using user authentication, you can optionally use spaces/{space}/members/app.

      Format: spaces/{space}/members/{member} or spaces/{space}/members/app

      You can use the user's email as an alias for {member}. For example, spaces/{space}/members/example@gmail.com where example@gmail.com is the email of the Google Chat user.

    • use_admin_access (::Boolean) (defaults to: nil) —

      Optional. When true, the method runs using the user's Google Workspace administrator privileges.

      The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

      Requires the chat.admin.memberships or chat.admin.memberships.readonly OAuth 2.0 scopes.

      Getting app memberships in a space isn't supported when using admin access.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 1066

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::GetMembershipRequest

  # 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
  call_metadata = @config.rpcs.get_membership.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.get_membership.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_membership.retry_policy

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

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

#get_message(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Message #get_message(name: nil) ⇒ ::Google::Apps::Chat::V1::Message

Returns details about a message. For an example, see Get details about a message.

Supports the following types of authentication:

  • App authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.bot: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and slash commands that invoke the Chat app.
    • https://www.googleapis.com/auth/chat.app.messages.readonly with administrator approval. When using this authentication scope, this method returns details about a public message in a space.

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages

Note: Might return a message from a blocked member or space.

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::GetMessageRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Message.
p result

Overloads:

  • #get_message(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Message

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

    Parameters:

    • request (::Google::Apps::Chat::V1::GetMessageRequest, ::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_message(name: nil) ⇒ ::Google::Apps::Chat::V1::Message

    Pass arguments to get_message 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. Resource name of the message.

      Format: spaces/{space}/messages/{message}

      If you've set a custom ID for your message, you can use the value from the clientAssignedMessageId field for {message}. For details, see Name a message.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 1178

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::GetMessageRequest

  # 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
  call_metadata = @config.rpcs.get_message.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.get_message.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_message.retry_policy

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

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

#get_space(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Space #get_space(name: nil, use_admin_access: nil) ⇒ ::Google::Apps::Chat::V1::Space

Returns details about a space. For an example, see Get details about a space.

Supports the following types of authentication:

  • App authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.spaces with administrator approval

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true, and one of the following authorization scopes is used:
      • https://www.googleapis.com/auth/chat.admin.spaces.readonly
      • https://www.googleapis.com/auth/chat.admin.spaces

App authentication has the following limitations:

  • space.access_settings is only populated when using the chat.app.spaces scope.
  • space.predefind_permission_settings and space.permission_settings are only populated when using the chat.app.spaces scope, and only for spaces the app created.

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::GetSpaceRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Space.
p result

Overloads:

  • #get_space(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Space

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

    Parameters:

    • request (::Google::Apps::Chat::V1::GetSpaceRequest, ::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_space(name: nil, use_admin_access: nil) ⇒ ::Google::Apps::Chat::V1::Space

    Pass arguments to get_space 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. Resource name of the space, in the form spaces/{space}.

      Format: spaces/{space}

    • use_admin_access (::Boolean) (defaults to: nil) —

      Optional. When true, the method runs using the user's Google Workspace administrator privileges.

      The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

      Requires the chat.admin.spaces or chat.admin.spaces.readonly OAuth 2.0 scopes.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 2354

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::GetSpaceRequest

  # 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
  call_metadata = @config.rpcs.get_space.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.get_space.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_space.retry_policy

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

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

#get_space_event(request, options = nil) ⇒ ::Google::Apps::Chat::V1::SpaceEvent #get_space_event(name: nil) ⇒ ::Google::Apps::Chat::V1::SpaceEvent

Returns an event from a Google Chat space. The event payload contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated Message resource in the event payload.

Note: The permissionSettings field is not returned in the Space object of the Space event data for this request.

Supports the following types of authentication with an authorization scope appropriate for reading the requested data:

  • App authentication with administrator approval with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.spaces.readonly
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.memberships.readonly

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

To get an event, the authenticated caller must be a member of the space.

For an example, see Get details about an event from a Google Chat space.

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::GetSpaceEventRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::SpaceEvent.
p result

Overloads:

  • #get_space_event(request, options = nil) ⇒ ::Google::Apps::Chat::V1::SpaceEvent

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

    Parameters:

    • request (::Google::Apps::Chat::V1::GetSpaceEventRequest, ::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_space_event(name: nil) ⇒ ::Google::Apps::Chat::V1::SpaceEvent

    Pass arguments to get_space_event 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 resource name of the space event.

      Format: spaces/{space}/spaceEvents/{spaceEvent}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 5496

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::GetSpaceEventRequest

  # 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
  call_metadata = @config.rpcs.get_space_event.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.get_space_event.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_space_event.retry_policy

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

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

#get_space_notification_setting(request, options = nil) ⇒ ::Google::Apps::Chat::V1::SpaceNotificationSetting #get_space_notification_setting(name: nil) ⇒ ::Google::Apps::Chat::V1::SpaceNotificationSetting

Gets the space notification setting. For an example, see Get the caller's space notification setting.

Requires user authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::GetSpaceNotificationSettingRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::SpaceNotificationSetting.
p result

Overloads:

  • #get_space_notification_setting(request, options = nil) ⇒ ::Google::Apps::Chat::V1::SpaceNotificationSetting

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

    Parameters:

    • request (::Google::Apps::Chat::V1::GetSpaceNotificationSettingRequest, ::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_space_notification_setting(name: nil) ⇒ ::Google::Apps::Chat::V1::SpaceNotificationSetting

    Pass arguments to get_space_notification_setting 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. Format: users/{user}/spaces/{space}/spaceNotificationSetting

      • users/me/spaces/{space}/spaceNotificationSetting, OR
      • users/user@example.com/spaces/{space}/spaceNotificationSetting, OR
      • users/123456789/spaces/{space}/spaceNotificationSetting. Note: Only the caller's user id or email is allowed in the path.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 5782

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::GetSpaceNotificationSettingRequest

  # 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
  call_metadata = @config.rpcs.get_space_notification_setting.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.get_space_notification_setting.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_space_notification_setting.retry_policy

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

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

#get_space_read_state(request, options = nil) ⇒ ::Google::Apps::Chat::V1::SpaceReadState #get_space_read_state(name: nil) ⇒ ::Google::Apps::Chat::V1::SpaceReadState

Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see Get details about a user's space read state.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::GetSpaceReadStateRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::SpaceReadState.
p result

Overloads:

  • #get_space_read_state(request, options = nil) ⇒ ::Google::Apps::Chat::V1::SpaceReadState

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

    Parameters:

    • request (::Google::Apps::Chat::V1::GetSpaceReadStateRequest, ::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_space_read_state(name: nil) ⇒ ::Google::Apps::Chat::V1::SpaceReadState

    Pass arguments to get_space_read_state 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. Resource name of the space read state to retrieve.

      Only supports getting read state for the calling user.

      To refer to the calling user, set one of the following:

      • The me alias. For example, users/me/spaces/{space}/spaceReadState.

      • Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState.

      • Their user id. For example, users/123456789/spaces/{space}/spaceReadState.

      Format: users/{user}/spaces/{space}/spaceReadState

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 4652

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::GetSpaceReadStateRequest

  # 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
  call_metadata = @config.rpcs.get_space_read_state.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.get_space_read_state.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_space_read_state.retry_policy

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

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

#get_thread_read_state(request, options = nil) ⇒ ::Google::Apps::Chat::V1::ThreadReadState #get_thread_read_state(name: nil) ⇒ ::Google::Apps::Chat::V1::ThreadReadState

Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see Get details about a user's thread read state.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::GetThreadReadStateRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::ThreadReadState.
p result

Overloads:

  • #get_thread_read_state(request, options = nil) ⇒ ::Google::Apps::Chat::V1::ThreadReadState

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

    Parameters:

    • request (::Google::Apps::Chat::V1::GetThreadReadStateRequest, ::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_thread_read_state(name: nil) ⇒ ::Google::Apps::Chat::V1::ThreadReadState

    Pass arguments to get_thread_read_state 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. Resource name of the thread read state to retrieve.

      Only supports getting read state for the calling user.

      To refer to the calling user, set one of the following:

      • The me alias. For example, users/me/spaces/{space}/threads/{thread}/threadReadState.

      • Their Workspace email address. For example, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

      • Their user id. For example, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

      Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 4871

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::GetThreadReadStateRequest

  # 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
  call_metadata = @config.rpcs.get_thread_read_state.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.get_thread_read_state.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_thread_read_state.retry_policy

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

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

#list_custom_emojis(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::CustomEmoji> #list_custom_emojis(page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::CustomEmoji>

Lists custom emojis visible to the authenticated user.

Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::ListCustomEmojisRequest.new

# Call the list_custom_emojis method.
result = client.list_custom_emojis 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::Apps::Chat::V1::CustomEmoji.
  p item
end

Overloads:

  • #list_custom_emojis(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::CustomEmoji>

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

    Parameters:

    • request (::Google::Apps::Chat::V1::ListCustomEmojisRequest, ::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_custom_emojis(page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::CustomEmoji>

    Pass arguments to list_custom_emojis 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) —

      Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.

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

      Optional. (If resuming from a previous query.)

      A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page.

      When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.

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

      Optional. A query filter.

      Supports filtering by creator.

      To filter by creator, you must specify a valid value. Currently only creator("users/me") and NOT creator("users/me") are accepted to filter custom emojis by whether they were created by the calling user or not.

      For example, the following query returns custom emojis created by the caller:

      creator("users/me")

      Invalid queries are rejected with an INVALID_ARGUMENT error.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 4445

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::ListCustomEmojisRequest

  # 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
  call_metadata = @config.rpcs.list_custom_emojis.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.list_custom_emojis.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_custom_emojis.retry_policy

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

  @chat_service_stub.list_custom_emojis request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @chat_service_stub, :list_custom_emojis, "custom_emojis", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_memberships(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Membership> #list_memberships(parent: nil, page_size: nil, page_token: nil, filter: nil, show_groups: nil, show_invited: nil, use_admin_access: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Membership>

Lists memberships in a space. For an example, see List users and Google Chat apps in a space. Listing memberships with app authentication lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with User authentication lists memberships in spaces that the authenticated user has access to.

Supports the following types of authentication:

  • App authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships (requires administrator approval)

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (import mode spaces only)
    • User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true, and one of the following authorization scopes is used:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::ListMembershipsRequest.new

# Call the list_memberships method.
result = client.list_memberships 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::Apps::Chat::V1::Membership.
  p item
end

Overloads:

  • #list_memberships(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Membership>

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

    Parameters:

    • request (::Google::Apps::Chat::V1::ListMembershipsRequest, ::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_memberships(parent: nil, page_size: nil, page_token: nil, filter: nil, show_groups: nil, show_invited: nil, use_admin_access: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Membership>

    Pass arguments to list_memberships 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 resource name of the space for which to fetch a membership list.

      Format: spaces/{space}

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

      Optional. The maximum number of memberships to return. The service might return fewer than this value.

      If unspecified, at most 100 memberships are returned.

      The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.

      Negative values return an INVALID_ARGUMENT error.

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

      Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page.

      When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

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

      Optional. A query filter.

      You can filter memberships by a member's role (role) and type (member.type).

      To filter by role, set role to ROLE_MEMBER or ROLE_MANAGER.

      To filter by type, set member.type to HUMAN or BOT. You can also filter for member.type using the != operator.

      To filter by both role and type, use the AND operator. To filter by either role or type, use the OR operator.

      Either member.type = "HUMAN" or member.type != "BOT" is required when use_admin_access is set to true. Other member type filters will be rejected.

      For example, the following queries are valid:

      role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

      The following queries are invalid:

      member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

      Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

    • show_groups (::Boolean) (defaults to: nil) —

      Optional. When true, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned.

    • show_invited (::Boolean) (defaults to: nil) —

      Optional. When true, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned.

      Currently requires user authentication.

    • use_admin_access (::Boolean) (defaults to: nil) —

      Optional. When true, the method runs using the user's Google Workspace administrator privileges.

      The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

      Requires either the chat.admin.memberships.readonly or chat.admin.memberships OAuth 2.0 scope.

      Listing app memberships in a space isn't supported when using admin access.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



940
941
942
943
944
945
946
947
948
949
950
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
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 940

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::ListMembershipsRequest

  # 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
  call_metadata = @config.rpcs.list_memberships.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.list_memberships.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_memberships.retry_policy

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

  @chat_service_stub.list_memberships request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @chat_service_stub, :list_memberships, "memberships", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_messages(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Message> #list_messages(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, show_deleted: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Message>

Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, {}. For an example, see List messages.

Supports the following types of authentication:

  • App authentication with administrator approval with the authorization scope:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages.

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (import mode spaces only)

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::ListMessagesRequest.new

# Call the list_messages method.
result = client.list_messages 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::Apps::Chat::V1::Message.
  p item
end

Overloads:

  • #list_messages(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Message>

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

    Parameters:

    • request (::Google::Apps::Chat::V1::ListMessagesRequest, ::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_messages(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, show_deleted: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Message>

    Pass arguments to list_messages 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 resource name of the space to list messages from.

      Format: spaces/{space}

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

      Optional. The maximum number of messages returned. The service might return fewer messages than this value.

      If unspecified, at most 25 are returned.

      The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.

      Negative values return an INVALID_ARGUMENT error.

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

      Optional. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page.

      When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

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

      Optional. A query filter.

      You can filter messages by date (create_time) and thread (thread.name).

      To filter messages by the date they were created, specify the create_time with a timestamp in RFC-3339 format and double quotation marks. For example, "2023-04-21T11:30:00-04:00". You can use the greater than operator > to list messages that were created after a timestamp, or the less than operator < to list messages that were created before a timestamp. To filter messages within a time interval, use the AND operator between two timestamps.

      To filter by thread, specify the thread.name, formatted as spaces/{space}/threads/{thread}. You can only specify one thread.name per query.

      To filter by both thread and date, use the AND operator in your query.

      For example, the following queries are valid:

      create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

      Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

    • order_by (::String) (defaults to: nil) —

      Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows:

      • ASC for ascending.

      • DESC for descending.

      The default ordering is create_time ASC.

    • show_deleted (::Boolean) (defaults to: nil) —

      Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 735

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::ListMessagesRequest

  # 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
  call_metadata = @config.rpcs.list_messages.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.list_messages.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_messages.retry_policy

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

  @chat_service_stub.list_messages request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @chat_service_stub, :list_messages, "messages", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_reactions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Reaction> #list_reactions(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Reaction>

Lists reactions to a message. For an example, see List reactions for a message.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::ListReactionsRequest.new

# Call the list_reactions method.
result = client.list_reactions 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::Apps::Chat::V1::Reaction.
  p item
end

Overloads:

  • #list_reactions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Reaction>

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

    Parameters:

    • request (::Google::Apps::Chat::V1::ListReactionsRequest, ::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_reactions(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Reaction>

    Pass arguments to list_reactions 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 message users reacted to.

      Format: spaces/{space}/messages/{message}

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

      Optional. The maximum number of reactions returned. The service can return fewer reactions than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.

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

      Optional. (If resuming from a previous query.)

      A page token received from a previous list reactions call. Provide this to retrieve the subsequent page.

      When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.

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

      Optional. A query filter.

      You can filter reactions by emoji (either emoji.unicode or emoji.custom_emoji.uid) and user (user.name).

      To filter reactions for multiple emojis or users, join similar fields with the OR operator, such as emoji.unicode = "🙂" OR emoji.unicode = "👍" and user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

      To filter reactions by emoji and user, use the AND operator, such as emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

      If your query uses both AND and OR, group them with parentheses.

      For example, the following queries are valid:

      user.name = "users/\\{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "\\{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}"
emoji.unicode = "🙂" AND user.name = "users/\\{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}")
AND user.name = "users/\\{user}"

      The following queries are invalid:

      emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "\\{uid}"
emoji.unicode = "🙂" OR user.name = "users/\\{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}" OR
user.name = "users/\\{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}"
AND user.name = "users/\\{user}"

      Invalid queries are rejected with an INVALID_ARGUMENT error.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 4038

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::ListReactionsRequest

  # 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
  call_metadata = @config.rpcs.list_reactions.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.list_reactions.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_reactions.retry_policy

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

  @chat_service_stub.list_reactions request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @chat_service_stub, :list_reactions, "reactions", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_section_items(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::SectionItem> #list_section_items(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::SectionItem>

Lists items in a section.

Only spaces can be section items. For details, see Create and organize sections in Google Chat.

Requires user authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::ListSectionItemsRequest.new

# Call the list_section_items method.
result = client.list_section_items 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::Apps::Chat::V1::SectionItem.
  p item
end

Overloads:

  • #list_section_items(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::SectionItem>

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

    Parameters:

    • request (::Google::Apps::Chat::V1::ListSectionItemsRequest, ::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_section_items(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::SectionItem>

    Pass arguments to list_section_items 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, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user.

      When you're filtering by space, use the wildcard - to search across all sections. For example, users/{user}/sections/-.

      Format: users/{user}/sections/{section}

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

      Optional. The maximum number of section items to return. The service may return fewer than this value.

      If unspecified, at most 10 section items will be returned.

      The maximum value is 100. If you use a value more than 100, it's automatically changed to 100.

      Negative values return an INVALID_ARGUMENT error.

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

      Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

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

      Optional. A query filter.

      Currently only supports filtering by space.

      For example, space = spaces/{space}.

      Invalid queries are rejected with an INVALID_ARGUMENT error.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 6505

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::ListSectionItemsRequest

  # 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
  call_metadata = @config.rpcs.list_section_items.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.list_section_items.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_section_items.retry_policy

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

  @chat_service_stub.list_section_items request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @chat_service_stub, :list_section_items, "section_items", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_sections(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Section> #list_sections(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Section>

Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see Create and organize sections in Google Chat.

Requires user authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::ListSectionsRequest.new

# Call the list_sections method.
result = client.list_sections 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::Apps::Chat::V1::Section.
  p item
end

Overloads:

  • #list_sections(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Section>

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

    Parameters:

    • request (::Google::Apps::Chat::V1::ListSectionsRequest, ::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_sections(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Section>

    Pass arguments to list_sections 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, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following:

      • The me alias. For example, users/me.

      • Their Workspace email address. For example, users/user@example.com.

      • Their user id. For example, users/123456789.

      Format: users/{user}

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

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

      If unspecified, at most 10 sections will be returned.

      The maximum value is 100. If you use a value more than 100, it's automatically changed to 100.

      Negative values return an INVALID_ARGUMENT error.

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

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

      When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 6277

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::ListSectionsRequest

  # 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
  call_metadata = @config.rpcs.list_sections.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.list_sections.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_sections.retry_policy

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

  @chat_service_stub.list_sections request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @chat_service_stub, :list_sections, "sections", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_space_events(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::SpaceEvent> #list_space_events(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::SpaceEvent>

Lists events from a Google Chat space. For each event, the payload contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns Membership resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty Membership resource.

Supports the following types of authentication with an authorization scope appropriate for reading the requested data:

  • App authentication with administrator approval with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.spaces.readonly
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.memberships.readonly

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

To list events, the authenticated caller must be a member of the space.

For an example, see List events from a Google Chat space.

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::ListSpaceEventsRequest.new

# Call the list_space_events method.
result = client.list_space_events 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::Apps::Chat::V1::SpaceEvent.
  p item
end

Overloads:

  • #list_space_events(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::SpaceEvent>

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

    Parameters:

    • request (::Google::Apps::Chat::V1::ListSpaceEventsRequest, ::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_space_events(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::SpaceEvent>

    Pass arguments to list_space_events 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. Resource name of the Google Chat space where the events occurred.

      Format: spaces/{space}.

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

      Optional. The maximum number of space events returned. The service might return fewer than this value.

      Negative values return an INVALID_ARGUMENT error.

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

      Optional. A page token, received from a previous list space events call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

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

      Required. A query filter.

      You must specify at least one event type (event_type) using the has : operator. To filter by multiple event types, use the OR operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions (google.workspace.chat.reaction.v1.created), the server also returns batch new reactions events (google.workspace.chat.reaction.v1.batchCreated). For a list of supported event types, see the SpaceEvents reference documentation.

      Optionally, you can also filter by start time (start_time) and end time (end_time):

      • start_time: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days.
      • end_time: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request.

      To specify a start or end time, use the equals = operator and format in RFC-3339. To filter by both start_time and end_time, use the AND operator.

      For example, the following queries are valid:

      start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

      start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

      The following queries are invalid:

      start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

      event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

      Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 5688

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::ListSpaceEventsRequest

  # 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
  call_metadata = @config.rpcs.list_space_events.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.list_space_events.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_space_events.retry_policy

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

  @chat_service_stub.list_space_events request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @chat_service_stub, :list_space_events, "space_events", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_spaces(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Space> #list_spaces(page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Space>

Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see List spaces.

Supports the following types of authentication:

  • App authentication with the authorization scope:

    • https://www.googleapis.com/auth/chat.bot

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces

To list all named spaces by Google Workspace organization, use the spaces.search() method using Workspace administrator privileges instead.

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::ListSpacesRequest.new

# Call the list_spaces method.
result = client.list_spaces 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::Apps::Chat::V1::Space.
  p item
end

Overloads:

  • #list_spaces(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Space>

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

    Parameters:

    • request (::Google::Apps::Chat::V1::ListSpacesRequest, ::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_spaces(page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Space>

    Pass arguments to list_spaces 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) —

      Optional. The maximum number of spaces to return. The service might return fewer than this value.

      If unspecified, at most 100 spaces are returned.

      The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.

      Negative values return an INVALID_ARGUMENT error.

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

      Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page.

      When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.

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

      Optional. A query filter.

      You can filter spaces by the space type (space_type).

      To filter by space type, you must specify valid enum value, such as SPACE or GROUP_CHAT (the space_type can't be SPACE_TYPE_UNSPECIFIED). To query for multiple space types, use the OR operator.

      For example, the following queries are valid:

      space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

      Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 2014

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::ListSpacesRequest

  # 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
  call_metadata = @config.rpcs.list_spaces.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.list_spaces.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_spaces.retry_policy

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

  @chat_service_stub.list_spaces request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @chat_service_stub, :list_spaces, "spaces", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


419
420
421
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 419

def logger
  @chat_service_stub.logger
end

#mark_as_active(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Availability #mark_as_active(name: nil, expire_time: nil, ttl: nil) ⇒ ::Google::Apps::Chat::V1::Availability

Marks user as ACTIVE in Google Chat.

Sets the user's availability state to ACTIVE. The ACTIVE state lasts until the specified expiration, at which point the user's state becomes AWAY. Note that if the user is actively using Chat, the ACTIVE state duration may extend beyond the provided expiration.

This method only updates the authenticated user's availability.

Requires user authentication with authorization scope:

  • https://www.googleapis.com/auth/chat.users.availability

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::MarkAsActiveRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Availability.
p result

Overloads:

  • #mark_as_active(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Availability

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

    Parameters:

    • request (::Google::Apps::Chat::V1::MarkAsActiveRequest, ::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.

  • #mark_as_active(name: nil, expire_time: nil, ttl: nil) ⇒ ::Google::Apps::Chat::V1::Availability

    Pass arguments to mark_as_active 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 resource name of the availability to mark as active. Format: users/{user}/availability

      {user} is the id for the Person in the People API or Admin SDK directory API. For example, users/123456789.

      The user's email address or me can also be used as an alias to refer to the caller. For example, users/user@example.com or users/me.

    • expire_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —

      The absolute timestamp when the ACTIVE state expires.

      Note: The following parameters are mutually exclusive: expire_time, ttl. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • ttl (::Google::Protobuf::Duration, ::Hash) (defaults to: nil) —

      The duration from the current time until the ACTIVE state expires. Using a short TTL can effectively reset the user's state to be based on activity after this brief duration.

      Note: The following parameters are mutually exclusive: ttl, expire_time. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 5078

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::MarkAsActiveRequest

  # 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
  call_metadata = @config.rpcs.mark_as_active.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.mark_as_active.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.mark_as_active.retry_policy

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

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

#mark_as_away(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Availability #mark_as_away(name: nil) ⇒ ::Google::Apps::Chat::V1::Availability

Marks user as AWAY in Google Chat.

Sets the user's state to away and is not affected by the user's activity.

This method only updates the authenticated user's availability.

Requires user authentication with authorization scope:

  • https://www.googleapis.com/auth/chat.users.availability

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::MarkAsAwayRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Availability.
p result

Overloads:

  • #mark_as_away(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Availability

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

    Parameters:

    • request (::Google::Apps::Chat::V1::MarkAsAwayRequest, ::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.

  • #mark_as_away(name: nil) ⇒ ::Google::Apps::Chat::V1::Availability

    Pass arguments to mark_as_away 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 resource name of the availability to mark as away. Format: users/{user}/availability

      {user} is the id for the Person in the People API or Admin SDK directory API. For example, users/123456789.

      The user's email address or me can also be used as an alias to refer to the caller. For example, users/user@example.com or users/me.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 5175

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::MarkAsAwayRequest

  # 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
  call_metadata = @config.rpcs.mark_as_away.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.mark_as_away.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.mark_as_away.retry_policy

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

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

#mark_as_do_not_disturb(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Availability #mark_as_do_not_disturb(name: nil, expire_time: nil, ttl: nil) ⇒ ::Google::Apps::Chat::V1::Availability

Marks user as DO_NOT_DISTURB in Google Chat.

Sets a user's availability state to DO_NOT_DISTURB until a specified expiration time. When in DO_NOT_DISTURB, users typically won't receive notifications.

This method only updates the authenticated user's availability.

Requires user authentication with authorization scope:

  • https://www.googleapis.com/auth/chat.users.availability

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::MarkAsDoNotDisturbRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Availability.
p result

Overloads:

  • #mark_as_do_not_disturb(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Availability

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

    Parameters:

    • request (::Google::Apps::Chat::V1::MarkAsDoNotDisturbRequest, ::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.

  • #mark_as_do_not_disturb(name: nil, expire_time: nil, ttl: nil) ⇒ ::Google::Apps::Chat::V1::Availability

    Pass arguments to mark_as_do_not_disturb 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 resource name of the availability to mark as Do Not Disturb. Format: users/{user}/availability

      {user} is the id for the Person in the People API or Admin SDK directory API. For example, users/123456789.

      The user's email address or me can also be used as an alias to refer to the caller. For example, users/user@example.com or users/me.

    • expire_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —

      The absolute timestamp when the DND state expires.

      Note: The following parameters are mutually exclusive: expire_time, ttl. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • ttl (::Google::Protobuf::Duration, ::Hash) (defaults to: nil) —

      The duration from the current time until the DND state expires.

      Note: The following parameters are mutually exclusive: ttl, expire_time. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 5281

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::MarkAsDoNotDisturbRequest

  # 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
  call_metadata = @config.rpcs.mark_as_do_not_disturb.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.mark_as_do_not_disturb.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.mark_as_do_not_disturb.retry_policy

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

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

#move_section_item(request, options = nil) ⇒ ::Google::Apps::Chat::V1::MoveSectionItemResponse #move_section_item(name: nil, target_section: nil) ⇒ ::Google::Apps::Chat::V1::MoveSectionItemResponse

Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see Create and organize sections in Google Chat.

Requires user authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.users.sections

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::MoveSectionItemRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::MoveSectionItemResponse.
p result

Overloads:

  • #move_section_item(request, options = nil) ⇒ ::Google::Apps::Chat::V1::MoveSectionItemResponse

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

    Parameters:

    • request (::Google::Apps::Chat::V1::MoveSectionItemRequest, ::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.

  • #move_section_item(name: nil, target_section: nil) ⇒ ::Google::Apps::Chat::V1::MoveSectionItemResponse

    Pass arguments to move_section_item 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 resource name of the section item to move.

      Format: users/{user}/sections/{section}/items/{item}

    • target_section (::String) (defaults to: nil) —

      Required. The resource name of the section to move the section item to.

      Format: users/{user}/sections/{section}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 6601

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::MoveSectionItemRequest

  # 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
  call_metadata = @config.rpcs.move_section_item.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.move_section_item.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.move_section_item.retry_policy

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

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

#position_section(request, options = nil) ⇒ ::Google::Apps::Chat::V1::PositionSectionResponse #position_section(name: nil, sort_order: nil, relative_position: nil) ⇒ ::Google::Apps::Chat::V1::PositionSectionResponse

Changes the sort order of a section. For details, see Create and organize sections in Google Chat.

Requires user authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.users.sections

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::PositionSectionRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::PositionSectionResponse.
p result

Overloads:

  • #position_section(request, options = nil) ⇒ ::Google::Apps::Chat::V1::PositionSectionResponse

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

    Parameters:

    • request (::Google::Apps::Chat::V1::PositionSectionRequest, ::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.

  • #position_section(name: nil, sort_order: nil, relative_position: nil) ⇒ ::Google::Apps::Chat::V1::PositionSectionResponse

    Pass arguments to position_section 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 resource name of the section to position.

      Format: users/{user}/sections/{section}

    • sort_order (::Integer) (defaults to: nil) —

      Optional. The absolute position of the section in the list of sections. The position must be greater than 0. If the position is greater than the number of sections, the section will be appended to the end of the list. This operation inserts the section at the given position and shifts the original section at that position, and those below it, to the next position.

      Note: The following parameters are mutually exclusive: sort_order, relative_position. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • relative_position (::Google::Apps::Chat::V1::PositionSectionRequest::Position) (defaults to: nil) —

      Optional. The relative position of the section in the list of sections.

      Note: The following parameters are mutually exclusive: relative_position, sort_order. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 6380

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::PositionSectionRequest

  # 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
  call_metadata = @config.rpcs.position_section.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.position_section.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.position_section.retry_policy

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

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

#search_messages(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::SearchMessageResult> #search_messages(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, view: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::SearchMessageResult>

Searches for messages in Google Chat that the calling user has access to. Returns a list of messages matching the search criteria.

To search across all spaces the user has access to, set parent to spaces/-. Using any other value for parent results in an INVALID_ARGUMENT error. The returned messages have their name field populated with the full resource name, which includes the specific space in which the message resides.

This API doesn't return all message types. The types of messages listed below aren't included in the response. Use ListMessages to list all messages.

  • Private Messages that are visible to the authenticated user.
  • Messages posted by Chat apps in spaces or group chats.
  • Messages in a Chat app DM.
  • Messages from blocked users.
  • Messages in spaces that the caller has muted.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::SearchMessagesRequest.new

# Call the search_messages method.
result = client.search_messages 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::Apps::Chat::V1::SearchMessageResult.
  p item
end

Overloads:

  • #search_messages(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::SearchMessageResult>

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

    Parameters:

    • request (::Google::Apps::Chat::V1::SearchMessagesRequest, ::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.

  • #search_messages(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, view: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::SearchMessageResult>

    Pass arguments to search_messages 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 resource name of the space to search within.

      To search across all spaces the user has access to, set this field to spaces/-. Using any other value for parent results in an INVALID_ARGUMENT error.

      To limit the search to one or more spaces, use space.name or space.display_name in the filter.

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

      Required. A search query.

      The query can specify one or more search keywords, which are used to filter the results,

      You can also filter the results using the following message fields:

      • create_time: Accepts a timestamp in RFC-3339 format and the supported comparison operators are: < and >=.
      • sender.name: The resource name of the sender (users/{user}). Only supports =. You can use the e-mail as an alias for {user}. For example, users/example@gmail.com, where example@gmail.com is the e-mail of the Google Chat user.
      • space.name: The resource name of the space where the message is posted. (spaces/{space}). Only supports =. If this filter is not set, the search is performed across all direct messages and spaces the user has access to as a space member.
      • space.display_name: Supports the operator : (has) and filters spaces based on a partial match of their display name. Results are limited to the top five space matches. For example, space.display_name:Project searches for messages in the top five spaces that contain the word "Project" in their display names.
      • attachment: Supports the operator :* (has any) to check for the presence of attachments. If attachment:* is specified, only messages that have at least one attachment are returned.
      • annotations.user_mentions.user.name: The resource name of the mentioned user (users/{user}). Only supports : (has). For example: annotations.user_mentions.user.name:"users/1234567890" returns only messages that contain a mention to the specified user. Alternatively, the alias me can be used to filter for messages that mention the caller user, for example: annotations.user_mentions.user.name:users/me. You can also use the e-mail as an alias for {user}, for example, users/example@gmail.com.

      For advanced filtering, the following functions are also available:

      • has_link(): Returns only messages that have at least one hyperlink in the message text.
      • is_unread(): Filters out messages that have been read by the calling user.

      Using the space.display_name filter requires that the calling credentials include one of the following authorization scopes:

      • https://www.googleapis.com/auth/chat.spaces.readonly
      • https://www.googleapis.com/auth/chat.spaces

      Using the is_unread() filter requires that the calling credentials include one of the following authorization scopes:

      • https://www.googleapis.com/auth/chat.users.readstate.readonly
      • https://www.googleapis.com/auth/chat.users.readstate

      Across different fields, only AND operators are supported. A valid example is sender.name = "users/1234567890" AND is_unread(). The word AND is optional and is implied if omitted. For example, sender.name = "users/1234567890" is_unread() is valid and is equivalent to the previous example. An invalid example is sender.name = "users/1234567890" OR is_unread() because OR is not supported between different fields.

      Among the same field:

      • create_time supports only AND, and can only be used to represent an interval, such as create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00".
      • sender.name supports only the OR operator, for example: sender.name = "users/1234567890" OR sender.name = "users/0987654321".
      • space.name supports only the OR operator, for example: space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI".
      • space.display_name supports the operators AND and OR, but not a mix of both. For example: space.display_name:Project AND space.display_name:Tasks returns messages that are in spaces with display names containing both Project and Tasks, whereas space.display_name:Project OR space.display_name:Tasks returns messages that are in spaces with display names containing either Project or Tasks or both.
      • annotations.user_mentions.user.name supports the operators AND and OR, but not a mix of both. For example: annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" returns only messages that mentions both users, whereas annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" returns messages that mention either user or both.

      Parentheses are required to disambiguate operator precedence when combining AND and OR operators in the same query. For example: (sender.name="users/me" OR sender.name="users/123456") AND is_unread(). Otherwise, parentheses are optional.

      The following example queries are valid:

      "Pending reports" AND create_time >= "2023-01-01T00:00:00Z"

sender.name = "users/example@gmail.com"

annotations.user_mentions.user.name:"users/0987654321"

attachment:* AND space.name = "spaces/ABCDEFGH"

tasks AND is_unread() AND sender.name = "users/1234567890"

"things to do" "urgent"

(sender.name = "users/1234567890")
AND (create_time < "2023-05-01T00:00:00Z")

tasks AND space.name = "spaces/ABCDEFGH" AND has_link()

"project one" is_unread()

space.display_name:Project tasks

      The maximum query length is 1,000 characters.

      Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

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

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

      If unspecified, at most 25 are returned.

      The maximum value is 100. If you use a value more than 100, it's automatically changed to 100.

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

      Optional. A token, received from the previous search messages call. Provide this parameter to retrieve the subsequent page.

      When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

    • order_by (::String) (defaults to: nil) —

      Optional. How the results list is ordered.

      Supported attributes to order by are:

      • create_time: Sorts the results by the time of the message creation. Default value.
      • relevance: Sorts the results by relevance. Developer Preview.

      The default ordering is create_time desc. Only a single order per query (create_time or relevance) is supported. Only descending order (desc) is supported, and it must be specified after the order attribute.

    • view (::Google::Apps::Chat::V1::SearchMessagesRequest::SearchMessagesView) (defaults to: nil) —

      Optional. Specifies what kind of search results view to return. The default is SEARCH_MESSAGES_VIEW_BASIC.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 1688

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::SearchMessagesRequest

  # 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
  call_metadata = @config.rpcs.search_messages.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.search_messages.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.search_messages.retry_policy

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

  @chat_service_stub.search_messages request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @chat_service_stub, :search_messages, "results", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_spaces(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Space> #search_spaces(use_admin_access: nil, page_size: nil, page_token: nil, query: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Space>

Returns a list of spaces in a Google Workspace organization based on an administrator's search. In the request, set use_admin_access to true. For an example, see Search for and manage spaces.

Requires user authentication with administrator privileges and one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::SearchSpacesRequest.new

# Call the search_spaces method.
result = client.search_spaces 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::Apps::Chat::V1::Space.
  p item
end

Overloads:

  • #search_spaces(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Space>

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

    Parameters:

    • request (::Google::Apps::Chat::V1::SearchSpacesRequest, ::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.

  • #search_spaces(use_admin_access: nil, page_size: nil, page_token: nil, query: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Chat::V1::Space>

    Pass arguments to search_spaces 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:

    • use_admin_access (::Boolean) (defaults to: nil) —

      When true, the method runs using the user's Google Workspace administrator privileges.

      The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

      Requires either the chat.admin.spaces.readonly or chat.admin.spaces OAuth 2.0 scope.

      This method currently only supports admin access, thus only true is accepted for this field.

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

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

      If unspecified, at most 100 spaces are returned.

      The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.

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

      A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page.

      When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

    • query (::String) (defaults to: nil) —

      Required. A search query.

      You can search by using the following parameters:

      • create_time
      • customer
      • display_name
      • external_user_allowed
      • last_active_time
      • space_history_state
      • space_type

      create_time and last_active_time accept a timestamp in RFC-3339 format and the supported comparison operators are: =, <, >, <=, >=.

      customer is required and is used to indicate which customer to fetch spaces from. customers/my_customer is the only supported value.

      display_name only accepts the HAS (:) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's display_name. For example, Fun Eve matches Fun event or The evening was fun, but not notFun event or even.

      external_user_allowed accepts either true or false.

      space_history_state only accepts values from the historyState field of a space resource.

      space_type is required and the only valid value is SPACE.

      Across different fields, only AND operators are supported. A valid example is space_type = "SPACE" AND display_name:"Hello" and an invalid example is space_type = "SPACE" OR display_name:"Hello".

      Among the same field, space_type doesn't support AND or OR operators. display_name, 'space_history_state', and 'external_user_allowed' only support OR operators. last_active_time and create_time support both AND and OR operators. AND can only be used to represent an interval, such as last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

      The following example queries are valid:

      customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
    • order_by (::String) (defaults to: nil) —

      Optional. How the list of spaces is ordered.

      Supported attributes to order by are:

      • membership_count.joined_direct_human_user_count — Denotes the count of human users that have directly joined a space.
      • last_active_time — Denotes the time when last eligible item is added to any topic of this space.
      • create_time — Denotes the time of the space creation.

      Valid ordering operation values are:

      • ASC for ascending. Default value.

      • DESC for descending.

      The supported syntax are:

      • membership_count.joined_direct_human_user_count DESC
      • membership_count.joined_direct_human_user_count ASC
      • last_active_time DESC
      • last_active_time ASC
      • create_time DESC
      • create_time ASC

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 2231

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::SearchSpacesRequest

  # 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
  call_metadata = @config.rpcs.search_spaces.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.search_spaces.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.search_spaces.retry_policy

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

  @chat_service_stub.search_spaces request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @chat_service_stub, :search_spaces, "spaces", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_up_space(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Space #set_up_space(space: nil, request_id: nil, memberships: nil) ⇒ ::Google::Apps::Chat::V1::Space

Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see Set up a space with initial members.

To specify the human members to add, add memberships with the appropriate membership.member.name. To add a human user, use users/{user}, where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id for the person from the People API, or the id for the user in the Directory API. For example, if the People API Person profile ID for user@example.com is 123456789, you can add the user to the space by setting the membership.member.name to users/user@example.com or users/123456789.

To specify the Google groups to add, add memberships with the appropriate membership.group_member.name. To add or invite a Google group, use groups/{group}, where {group} is the id for the group from the Cloud Identity Groups API. For example, you can use Cloud Identity Groups lookup API to retrieve the ID 123456789 for group email group@example.com, then you can add the group to the space by setting the membership.group_member.name to groups/123456789. Group email is not supported, and Google groups can only be added as members in named spaces.

For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space.

To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created.

To create a DM between the calling user and the calling app, set Space.singleUserBotDm to true and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see Invite or add a user or app to a space.

If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned.

Spaces with threaded replies aren't supported. If you receive the error message ALREADY_EXISTS when setting up a space, try a different displayName. An existing space within the Google Workspace organization might already use this display name.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.spaces.create
  • https://www.googleapis.com/auth/chat.spaces

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::SetUpSpaceRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Space.
p result

Overloads:

  • #set_up_space(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Space

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

    Parameters:

    • request (::Google::Apps::Chat::V1::SetUpSpaceRequest, ::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.

  • #set_up_space(space: nil, request_id: nil, memberships: nil) ⇒ ::Google::Apps::Chat::V1::Space

    Pass arguments to set_up_space 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:

    • space (::Google::Apps::Chat::V1::Space, ::Hash) (defaults to: nil) —

      Required. The Space.spaceType field is required.

      To create a space, set Space.spaceType to SPACE and set Space.displayName. If you receive the error message ALREADY_EXISTS when setting up a space, try a different displayName. An existing space within the Google Workspace organization might already use this display name.

      To create a group chat, set Space.spaceType to GROUP_CHAT. Don't set Space.displayName.

      To create a 1:1 conversation between humans, set Space.spaceType to DIRECT_MESSAGE and set Space.singleUserBotDm to false. Don't set Space.displayName or Space.spaceDetails.

      To create an 1:1 conversation between a human and the calling Chat app, set Space.spaceType to DIRECT_MESSAGE and Space.singleUserBotDm to true. Don't set Space.displayName or Space.spaceDetails.

      If a DIRECT_MESSAGE space already exists, that space is returned instead of creating a new space.

    • request_id (::String) (defaults to: nil) —

      Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.

    • memberships (::Array<::Google::Apps::Chat::V1::Membership, ::Hash>) (defaults to: nil) —

      Optional. The Google Chat users or groups to invite to join the space. Omit the calling user, as they are added automatically.

      The set currently allows up to 49 memberships (in addition to the caller).

      For human membership, the Membership.member field must contain a user with name populated (format: users/{user}) and type set to User.Type.HUMAN. You can only add human users when setting up a space (adding Chat apps is only supported for direct message setup with the calling app). You can also add members using the user's email as an alias for {user}. For example, the user.name can be users/example@gmail.com. To invite Gmail users or users from external Google Workspace domains, user's email must be used for {user}.

      For Google group membership, the Membership.group_member field must contain a group with name populated (format groups/{group}). You can only add Google groups when setting Space.spaceType to SPACE.

      Optional when setting Space.spaceType to SPACE.

      Required when setting Space.spaceType to GROUP_CHAT, along with at least two memberships.

      Required when setting Space.spaceType to DIRECT_MESSAGE with a human user, along with exactly one membership.

      Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting Space.spaceType to DIRECT_MESSAGE and Space.singleUserBotDm to true).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 2683

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::SetUpSpaceRequest

  # 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
  call_metadata = @config.rpcs.set_up_space.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.set_up_space.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_up_space.retry_policy

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

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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


352
353
354
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 352

def universe_domain
  @chat_service_stub.universe_domain
end

#update_availability(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Availability #update_availability(availability: nil, update_mask: nil) ⇒ ::Google::Apps::Chat::V1::Availability

Updates availability information for a human user. Only the custom_status field can be updated through this method.

This method only updates the authenticated user's availability.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.users.availability

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::UpdateAvailabilityRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Availability.
p result

Overloads:

  • #update_availability(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Availability

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

    Parameters:

    • request (::Google::Apps::Chat::V1::UpdateAvailabilityRequest, ::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.

  • #update_availability(availability: nil, update_mask: nil) ⇒ ::Google::Apps::Chat::V1::Availability

    Pass arguments to update_availability 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.



5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 5372

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::UpdateAvailabilityRequest

  # 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
  call_metadata = @config.rpcs.update_availability.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.update_availability.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_availability.retry_policy

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

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

#update_membership(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Membership #update_membership(membership: nil, update_mask: nil, use_admin_access: nil) ⇒ ::Google::Apps::Chat::V1::Membership

Updates a membership. For an example, see Update a user's membership in a space.

Supports the following types of authentication:

  • App authentication with administrator approval and the authorization scope:

    • https://www.googleapis.com/auth/chat.app.memberships (only in spaces the app created)

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (import mode spaces only)
    • User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true, and the following authorization scope is used:
      • https://www.googleapis.com/auth/chat.admin.memberships

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::UpdateMembershipRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Membership.
p result

Overloads:

  • #update_membership(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Membership

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

    Parameters:

    • request (::Google::Apps::Chat::V1::UpdateMembershipRequest, ::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.

  • #update_membership(membership: nil, update_mask: nil, use_admin_access: nil) ⇒ ::Google::Apps::Chat::V1::Membership

    Pass arguments to update_membership 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:

    • membership (::Google::Apps::Chat::V1::Membership, ::Hash) (defaults to: nil) —

      Required. The membership to update. Only fields specified by update_mask are updated.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. The field paths to update. Separate multiple values with commas or use * to update all field paths.

      Currently supported field paths:

      • role
    • use_admin_access (::Boolean) (defaults to: nil) —

      Optional. When true, the method runs using the user's Google Workspace administrator privileges.

      The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

      Requires the chat.admin.memberships OAuth 2.0 scope.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 3651

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::UpdateMembershipRequest

  # 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
  call_metadata = @config.rpcs.update_membership.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.update_membership.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_membership.retry_policy

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

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

#update_message(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Message #update_message(message: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Apps::Chat::V1::Message

Updates a message. There's a difference between the patch and update methods. The patch method uses a patch request while the update method uses a put request. We recommend using the patch method. For an example, see Update a message.

Supports the following types of authentication:

  • App authentication with the authorization scope:

    • https://www.googleapis.com/auth/chat.bot

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (import mode spaces only)

When using app authentication, requests can only update messages created by the calling Chat app.

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::UpdateMessageRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Message.
p result

Overloads:

  • #update_message(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Message

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

    Parameters:

    • request (::Google::Apps::Chat::V1::UpdateMessageRequest, ::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.

  • #update_message(message: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Apps::Chat::V1::Message

    Pass arguments to update_message 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:

    • message (::Google::Apps::Chat::V1::Message, ::Hash) (defaults to: nil) —

      Required. Message with fields updated.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. The field paths to update. Separate multiple values with commas or use * to update all field paths.

      Currently supported field paths:

    • allow_missing (::Boolean) (defaults to: nil) —

      Optional. If true and the message isn't found, a new message is created and updateMask is ignored. The specified message ID must be client-assigned or the request fails.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 1304

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::UpdateMessageRequest

  # 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
  call_metadata = @config.rpcs.update_message.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.update_message.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_message.retry_policy

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

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

#update_section(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Section #update_section(section: nil, update_mask: nil) ⇒ ::Google::Apps::Chat::V1::Section

Updates a section. Only sections of type CUSTOM_SECTION can be updated. For details, see Create and organize sections in Google Chat.

Requires user authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.users.sections

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::UpdateSectionRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Section.
p result

Overloads:

  • #update_section(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Section

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

    Parameters:

    • request (::Google::Apps::Chat::V1::UpdateSectionRequest, ::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.

  • #update_section(section: nil, update_mask: nil) ⇒ ::Google::Apps::Chat::V1::Section

    Pass arguments to update_section 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.



6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 6157

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::UpdateSectionRequest

  # 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
  call_metadata = @config.rpcs.update_section.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.update_section.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_section.retry_policy

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

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

#update_space(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Space #update_space(space: nil, update_mask: nil, use_admin_access: nil) ⇒ ::Google::Apps::Chat::V1::Space

Updates a space. For an example, see Update a space.

If you're updating the displayName field and receive the error message ALREADY_EXISTS, try a different display name.. An existing space within the Google Workspace organization might already use this display name.

Supports the following types of authentication:

  • App authentication with administrator approval and one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.app.spaces

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (import mode spaces only)
    • User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true, and the following authorization scopes is used:
      • https://www.googleapis.com/auth/chat.admin.spaces

App authentication has the following limitations:

  • To update either space.predefined_permission_settings or space.permission_settings, the app must be the space creator.
  • Updating the space.access_settings.audience is not supported for app authentication.

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::UpdateSpaceRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::Space.
p result

Overloads:

  • #update_space(request, options = nil) ⇒ ::Google::Apps::Chat::V1::Space

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

    Parameters:

    • request (::Google::Apps::Chat::V1::UpdateSpaceRequest, ::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.

  • #update_space(space: nil, update_mask: nil, use_admin_access: nil) ⇒ ::Google::Apps::Chat::V1::Space

    Pass arguments to update_space 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:

    • space (::Google::Apps::Chat::V1::Space, ::Hash) (defaults to: nil) —

      Required. Space with fields to be updated. Space.name must be populated in the form of spaces/{space}. Only fields specified by update_mask are updated.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. The updated field paths, comma separated if there are multiple.

      You can update the following fields for a space:

      space_details: Updates the space's description and guidelines. You must pass both description and guidelines in the update request as SpaceDetails. If you only want to update one of the fields, pass the existing value for the other field.

      display_name: Only supports updating the display name for spaces where spaceType field is SPACE. If you receive the error message ALREADY_EXISTS, try a different value. An existing space within the Google Workspace organization might already use this display name.

      space_type: Only supports changing a GROUP_CHAT space type to SPACE. Include display_name together with space_type in the update mask and ensure that the specified space has a non-empty display name and the SPACE space type. Including the space_type mask and the SPACE type in the specified space when updating the display name is optional if the existing space already has the SPACE type. Trying to update the space type in other ways results in an invalid argument error. space_type is not supported with useAdminAccess.

      space_history_state: Updates space history settings by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. space_history_state is not supported with useAdminAccess.

      access_settings.audience: Updates the access setting of who can discover the space, join the space, and preview the messages in named space where spaceType field is SPACE. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in import mode. To learn more, see Make a space discoverable to specific users. access_settings.audience is not supported with useAdminAccess.

      access_settings.access_permission_settings: Updates the access permission settings of who can discover and join the space where spaceType field is SPACE. Principals allowed to join the space must also be allowed to discover it. To update access permission settings for a space, the authenticating user must be a space manager or assistant manager and omit all other field masks in the request. You can't update this field if the space is in import mode. To learn more, see Make a space discoverable to specific users. access_settings.access_permission_settings is not supported with useAdminAccess. The supported field masks include:

      • access_settings.access_permission_settings.discoverSpaceSetting
      • access_settings.access_permission_settings.joinSpaceSetting

      permission_settings: Supports changing the permission settings of a space. When updating permission settings, you can only specify permissionSettings field masks; you cannot update other field masks at the same time. The supported field masks include:

      • permission_settings.manageMembersAndGroups
      • permission_settings.modifySpaceDetails
      • permission_settings.toggleHistory
      • permission_settings.useAtMentionAll
      • permission_settings.manageApps
      • permission_settings.manageWebhooks
      • permission_settings.replyMessages
    • use_admin_access (::Boolean) (defaults to: nil) —

      Optional. When true, the method runs using the user's Google Workspace administrator privileges.

      The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

      Requires the chat.admin.spaces OAuth 2.0 scope.

      Some FieldMask values are not supported using admin access. For details, see the description of update_mask.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 2890

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::UpdateSpaceRequest

  # 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
  call_metadata = @config.rpcs.update_space.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.update_space.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_space.retry_policy

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

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

#update_space_notification_setting(request, options = nil) ⇒ ::Google::Apps::Chat::V1::SpaceNotificationSetting #update_space_notification_setting(space_notification_setting: nil, update_mask: nil) ⇒ ::Google::Apps::Chat::V1::SpaceNotificationSetting

Updates the space notification setting. For an example, see Update the caller's space notification setting.

Requires user authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::UpdateSpaceNotificationSettingRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::SpaceNotificationSetting.
p result

Overloads:

  • #update_space_notification_setting(request, options = nil) ⇒ ::Google::Apps::Chat::V1::SpaceNotificationSetting

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

    Parameters:

    • request (::Google::Apps::Chat::V1::UpdateSpaceNotificationSettingRequest, ::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.

  • #update_space_notification_setting(space_notification_setting: nil, update_mask: nil) ⇒ ::Google::Apps::Chat::V1::SpaceNotificationSetting

    Pass arguments to update_space_notification_setting 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:

    • space_notification_setting (::Google::Apps::Chat::V1::SpaceNotificationSetting, ::Hash) (defaults to: nil) —

      Required. The resource name for the space notification settings must be populated in the form of users/{user}/spaces/{space}/spaceNotificationSetting. Only fields specified by update_mask are updated.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Supported field paths:

      • notification_setting

      • mute_setting

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 5878

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::UpdateSpaceNotificationSettingRequest

  # 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
  call_metadata = @config.rpcs.update_space_notification_setting.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.update_space_notification_setting.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_space_notification_setting.retry_policy

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

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

#update_space_read_state(request, options = nil) ⇒ ::Google::Apps::Chat::V1::SpaceReadState #update_space_read_state(space_read_state: nil, update_mask: nil) ⇒ ::Google::Apps::Chat::V1::SpaceReadState

Updates a user's read state within a space, used to identify read and unread messages. For an example, see Update a user's space read state.

Requires user authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.users.readstate

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::UpdateSpaceReadStateRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::SpaceReadState.
p result

Overloads:

  • #update_space_read_state(request, options = nil) ⇒ ::Google::Apps::Chat::V1::SpaceReadState

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

    Parameters:

    • request (::Google::Apps::Chat::V1::UpdateSpaceReadStateRequest, ::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.

  • #update_space_read_state(space_read_state: nil, update_mask: nil) ⇒ ::Google::Apps::Chat::V1::SpaceReadState

    Pass arguments to update_space_read_state 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:

    • space_read_state (::Google::Apps::Chat::V1::SpaceReadState, ::Hash) (defaults to: nil) —

      Required. The space read state and fields to update.

      Only supports updating read state for the calling user.

      To refer to the calling user, set one of the following:

      • The me alias. For example, users/me/spaces/{space}/spaceReadState.

      • Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState.

      • Their user id. For example, users/123456789/spaces/{space}/spaceReadState.

      Format: users/{user}/spaces/{space}/spaceReadState

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. The field paths to update. Currently supported field paths:

      • last_read_time

      When the last_read_time is before the latest message create time, the space appears as unread in the UI.

      To mark the space as read, set last_read_time to any value later (larger) than the latest message create time. The last_read_time is coerced to match the latest message create time. Note that the space read state only affects the read state of messages that are visible in the space's top-level conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread read state.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 4767

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::UpdateSpaceReadStateRequest

  # 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
  call_metadata = @config.rpcs.update_space_read_state.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.update_space_read_state.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_space_read_state.retry_policy

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

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

#upload_attachment(request, options = nil) ⇒ ::Google::Apps::Chat::V1::UploadAttachmentResponse #upload_attachment(parent: nil, filename: nil) ⇒ ::Google::Apps::Chat::V1::UploadAttachmentResponse

Uploads an attachment. For an example, see Upload media as a file attachment.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.messages.create
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (import mode spaces only)

You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see File types blocked by Google Chat.

Examples:

Basic example

require "google/apps/chat/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Chat::V1::ChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Chat::V1::UploadAttachmentRequest.new

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

# The returned object is of type Google::Apps::Chat::V1::UploadAttachmentResponse.
p result

Overloads:

  • #upload_attachment(request, options = nil) ⇒ ::Google::Apps::Chat::V1::UploadAttachmentResponse

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

    Parameters:

    • request (::Google::Apps::Chat::V1::UploadAttachmentRequest, ::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.

  • #upload_attachment(parent: nil, filename: nil) ⇒ ::Google::Apps::Chat::V1::UploadAttachmentResponse

    Pass arguments to upload_attachment 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. Resource name of the Chat space in which the attachment is uploaded. Format "spaces/{space}".

    • filename (::String) (defaults to: nil) —

      Required. The filename of the attachment, including the file extension.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
 
# File 'lib/google/apps/chat/v1/chat_service/rest/client.rb', line 1877

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Chat::V1::UploadAttachmentRequest

  # 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
  call_metadata = @config.rpcs.upload_attachment.metadata.to_h

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

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

  options.apply_defaults timeout:      @config.rpcs.upload_attachment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.upload_attachment.retry_policy

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

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