Class: Google::Apps::Meet::V2beta::SpacesService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/apps/meet/v2beta/spaces_service/rest/client.rb

Overview

REST client for the SpacesService service.

REST API for services dealing with spaces.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#conference_record_path, #member_path, #space_path

Constructor Details

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

Create a new SpacesService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Apps::Meet::V2beta::SpacesService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Apps::Meet::V2beta::SpacesService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the SpacesService client.

Yield Parameters:



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
 
# File 'lib/google/apps/meet/v2beta/spaces_service/rest/client.rb', line 145

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

  @spaces_service_stub = ::Google::Apps::Meet::V2beta::SpacesService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @spaces_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 SpacesService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all SpacesService clients
::Google::Apps::Meet::V2beta::SpacesService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
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
 
# File 'lib/google/apps/meet/v2beta/spaces_service/rest/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Apps", "Meet", "V2beta"]
    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_space.timeout = 60.0

    default_config.rpcs.get_space.timeout = 60.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.update_space.timeout = 60.0

    default_config.rpcs.end_active_conference.timeout = 60.0

    default_config.rpcs.create_member.timeout = 60.0

    default_config.rpcs.get_member.timeout = 60.0

    default_config.rpcs.list_members.timeout = 60.0

    default_config.rpcs.delete_member.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

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



115
116
117
118
 
# File 'lib/google/apps/meet/v2beta/spaces_service/rest/client.rb', line 115

def configure
  yield @config if block_given?
  @config
end

#connect_active_conference(request, options = nil) ⇒ ::Google::Apps::Meet::V2beta::ConnectActiveConferenceResponse #connect_active_conference(name: nil, offer: nil) ⇒ ::Google::Apps::Meet::V2beta::ConnectActiveConferenceResponse

Developer Preview: Broker a WebRTC connection to the active conference of a space.

On success, clients must use the resulting SDP (Session Description Protocol) answer to establish a WebRTC connection. Once connected, additional functionality is available across WebRTC data channels.

See Meet Media API overview for more details about this connection.

Examples:

Basic example

require "google/apps/meet/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2beta::SpacesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2beta::ConnectActiveConferenceRequest.new

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

# The returned object is of type Google::Apps::Meet::V2beta::ConnectActiveConferenceResponse.
p result

Overloads:

  • #connect_active_conference(request, options = nil) ⇒ ::Google::Apps::Meet::V2beta::ConnectActiveConferenceResponse

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

    Parameters:

    • request (::Google::Apps::Meet::V2beta::ConnectActiveConferenceRequest, ::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.

  • #connect_active_conference(name: nil, offer: nil) ⇒ ::Google::Apps::Meet::V2beta::ConnectActiveConferenceResponse

    Pass arguments to connect_active_conference 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. Format: spaces/{spaceId}

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

      Required. WebRTC SDP (Session Description Protocol) offer from the client.

      The format is defined by RFC 8866 with mandatory keys defined by RFC 8829. This is the standard SDP format generated by a peer connection's createOffer() and createAnswer() methods.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/google/apps/meet/v2beta/spaces_service/rest/client.rb', line 525

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2beta::ConnectActiveConferenceRequest

  # 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.connect_active_conference.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::Meet::V2beta::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.connect_active_conference.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.connect_active_conference.retry_policy

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

  @spaces_service_stub.connect_active_conference 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_member(request, options = nil) ⇒ ::Google::Apps::Meet::V2beta::Member #create_member(parent: nil, member: nil) ⇒ ::Google::Apps::Meet::V2beta::Member

Developer Preview: Create a member.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted, this API response will default to "name,email,role,user".

Examples:

Basic example

require "google/apps/meet/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2beta::SpacesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2beta::CreateMemberRequest.new

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

# The returned object is of type Google::Apps::Meet::V2beta::Member.
p result

Overloads:

  • #create_member(request, options = nil) ⇒ ::Google::Apps::Meet::V2beta::Member

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

    Parameters:

    • request (::Google::Apps::Meet::V2beta::CreateMemberRequest, ::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_member(parent: nil, member: nil) ⇒ ::Google::Apps::Meet::V2beta::Member

    Pass arguments to create_member 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. Format: spaces/{space}

    • member (::Google::Apps::Meet::V2beta::Member, ::Hash) (defaults to: nil) —

      Required. The member to be created.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
 
# File 'lib/google/apps/meet/v2beta/spaces_service/rest/client.rb', line 700

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2beta::CreateMemberRequest

  # 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_member.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::Meet::V2beta::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_member.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_member.retry_policy

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

  @spaces_service_stub.create_member 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::Meet::V2beta::Space #create_space(space: nil) ⇒ ::Google::Apps::Meet::V2beta::Space

Creates a space.

Examples:

Basic example

require "google/apps/meet/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2beta::SpacesService::Rest::Client.new

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

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

# The returned object is of type Google::Apps::Meet::V2beta::Space.
p result

Overloads:

  • #create_space(request, options = nil) ⇒ ::Google::Apps::Meet::V2beta::Space

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

    Parameters:

    • request (::Google::Apps::Meet::V2beta::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) ⇒ ::Google::Apps::Meet::V2beta::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::Meet::V2beta::Space, ::Hash) (defaults to: nil) —

      Space to be created. As of May 2023, the input space can be empty. Later on the input space can be non-empty when space configuration is introduced.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/apps/meet/v2beta/spaces_service/rest/client.rb', line 242

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2beta::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::Meet::V2beta::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

  @spaces_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_member(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_member(name: nil) ⇒ ::Google::Protobuf::Empty

Developer Preview: Delete the member who was previously assigned roles in the space.

Examples:

Basic example

require "google/apps/meet/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2beta::SpacesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2beta::DeleteMemberRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Apps::Meet::V2beta::DeleteMemberRequest, ::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_member(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_member 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: “spaces/{space}/members/{member}”

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
 
# File 'lib/google/apps/meet/v2beta/spaces_service/rest/client.rb', line 960

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2beta::DeleteMemberRequest

  # 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_member.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::Meet::V2beta::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_member.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_member.retry_policy

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

  @spaces_service_stub.delete_member 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

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

Ends an active conference (if there's one).

For an example, see End active conference.

Examples:

Basic example

require "google/apps/meet/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2beta::SpacesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2beta::EndActiveConferenceRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Apps::Meet::V2beta::EndActiveConferenceRequest, ::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.

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

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

      Format: spaces/{space}.

      {space} is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, jQCFfuBOdN5z.

      For more information, see How Meet identifies a meeting 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.



614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/google/apps/meet/v2beta/spaces_service/rest/client.rb', line 614

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2beta::EndActiveConferenceRequest

  # 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.end_active_conference.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::Meet::V2beta::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.end_active_conference.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.end_active_conference.retry_policy

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

  @spaces_service_stub.end_active_conference 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_member(request, options = nil) ⇒ ::Google::Apps::Meet::V2beta::Member #get_member(name: nil) ⇒ ::Google::Apps::Meet::V2beta::Member

Developer Preview: Get a member.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted, this API response will default to "name,email,role,user".

Examples:

Basic example

require "google/apps/meet/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2beta::SpacesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2beta::GetMemberRequest.new

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

# The returned object is of type Google::Apps::Meet::V2beta::Member.
p result

Overloads:

  • #get_member(request, options = nil) ⇒ ::Google::Apps::Meet::V2beta::Member

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

    Parameters:

    • request (::Google::Apps::Meet::V2beta::GetMemberRequest, ::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_member(name: nil) ⇒ ::Google::Apps::Meet::V2beta::Member

    Pass arguments to get_member 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: “spaces/{space}/members/{member}”

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2beta::GetMemberRequest

  # 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_member.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::Meet::V2beta::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_member.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_member.retry_policy

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

  @spaces_service_stub.get_member 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::Meet::V2beta::Space #get_space(name: nil) ⇒ ::Google::Apps::Meet::V2beta::Space

Gets details about a meeting space.

For an example, see Get a meeting space.

Examples:

Basic example

require "google/apps/meet/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2beta::SpacesService::Rest::Client.new

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

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

# The returned object is of type Google::Apps::Meet::V2beta::Space.
p result

Overloads:

  • #get_space(request, options = nil) ⇒ ::Google::Apps::Meet::V2beta::Space

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

    Parameters:

    • request (::Google::Apps::Meet::V2beta::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) ⇒ ::Google::Apps::Meet::V2beta::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.

      Format: spaces/{space} or spaces/{meetingCode}.

      {space} is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, jQCFfuBOdN5z.

      {meetingCode} is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, abc-mnop-xyz. The maximum length is 128 characters.

      A meetingCode shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a meetingCode expires 365 days after last use. For more information, see Learn about meeting codes in Google Meet.

      For more information, see How Meet identifies a meeting 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.



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/google/apps/meet/v2beta/spaces_service/rest/client.rb', line 341

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2beta::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::Meet::V2beta::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

  @spaces_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

#list_members(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2beta::Member> #list_members(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2beta::Member>

Developer Preview: List members.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted this API response will default to "name,email,role,user".

Examples:

Basic example

require "google/apps/meet/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2beta::SpacesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2beta::ListMembersRequest.new

# Call the list_members method.
result = client.list_members 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::Meet::V2beta::Member.
  p item
end

Overloads:

  • #list_members(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2beta::Member>

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

    Parameters:

    • request (::Google::Apps::Meet::V2beta::ListMembersRequest, ::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_members(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2beta::Member>

    Pass arguments to list_members 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. Format: spaces/{space}

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

      Optional. Maximum number of members to return. The service might return fewer than this value. If unspecified, at most 25 members are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.

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

      Optional. Page token returned from previous List Call.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'lib/google/apps/meet/v2beta/spaces_service/rest/client.rb', line 879

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2beta::ListMembersRequest

  # 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_members.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::Meet::V2beta::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_members.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_members.retry_policy

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

  @spaces_service_stub.list_members request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @spaces_service_stub, :list_members, "members", 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) 


192
193
194
 
# File 'lib/google/apps/meet/v2beta/spaces_service/rest/client.rb', line 192

def logger
  @spaces_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


125
126
127
 
# File 'lib/google/apps/meet/v2beta/spaces_service/rest/client.rb', line 125

def universe_domain
  @spaces_service_stub.universe_domain
end

#update_space(request, options = nil) ⇒ ::Google::Apps::Meet::V2beta::Space #update_space(space: nil, update_mask: nil) ⇒ ::Google::Apps::Meet::V2beta::Space

Updates details about a meeting space.

For an example, see Update a meeting space.

Examples:

Basic example

require "google/apps/meet/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2beta::SpacesService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2beta::UpdateSpaceRequest.new

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

# The returned object is of type Google::Apps::Meet::V2beta::Space.
p result

Overloads:

  • #update_space(request, options = nil) ⇒ ::Google::Apps::Meet::V2beta::Space

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

    Parameters:

    • request (::Google::Apps::Meet::V2beta::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) ⇒ ::Google::Apps::Meet::V2beta::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::Meet::V2beta::Space, ::Hash) (defaults to: nil) —

      Required. Space to be updated.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided(not set, set with empty paths, or only has "" as paths), it defaults to update all fields provided with values in the request. Using "*" as update_mask will update all fields, including deleting fields not set in the request.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/google/apps/meet/v2beta/spaces_service/rest/client.rb', line 429

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2beta::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::Meet::V2beta::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

  @spaces_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