Google Meet V2 API - Class Google::Apps::Meet::V2::SpacesService::Client (v0.2.2)

Reference documentation and code samples for the Google Meet V2 API class Google::Apps::Meet::V2::SpacesService::Client.

Client for the SpacesService service.

REST API for services dealing with spaces.

Inherits

Object

Includes

Google::Apps::Meet::V2::SpacesService::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the SpacesService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

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

#configure

def 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_space

def create_space(request, options = nil) -> ::Google::Apps::Meet::V2::Space
def create_space(space: nil) -> ::Google::Apps::Meet::V2::Space

Creates a space.

Overloads

def create_space(request, options = nil) -> ::Google::Apps::Meet::V2::Space

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

Parameters

request (::Google::Apps::Meet::V2::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_space(space: nil) -> ::Google::Apps::Meet::V2::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).

Parameter

space (::Google::Apps::Meet::V2::Space, ::Hash) — 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

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Apps::Meet::V2::Space)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Apps::Meet::V2::Space)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/apps/meet/v2"

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

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

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

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

#end_active_conference

def end_active_conference(request, options = nil) -> ::Google::Protobuf::Empty
def end_active_conference(name: nil) -> ::Google::Protobuf::Empty

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

Overloads

def 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::V2::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. Resource name of the space.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/apps/meet/v2"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2::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

#get_space

def get_space(request, options = nil) -> ::Google::Apps::Meet::V2::Space
def get_space(name: nil) -> ::Google::Apps::Meet::V2::Space

Gets a space by space_id or meeting_code.

Overloads

def get_space(request, options = nil) -> ::Google::Apps::Meet::V2::Space

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

Parameters

request (::Google::Apps::Meet::V2::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_space(name: nil) -> ::Google::Apps::Meet::V2::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).

Parameter

name (::String) — Required. Resource name of the space.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Apps::Meet::V2::Space)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Apps::Meet::V2::Space)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/apps/meet/v2"

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

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

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

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

#initialize

def initialize() { |config| ... } -> Client

Create a new SpacesService client object.

Yields

(config) — Configure the SpacesService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

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

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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_space

def update_space(request, options = nil) -> ::Google::Apps::Meet::V2::Space
def update_space(space: nil, update_mask: nil) -> ::Google::Apps::Meet::V2::Space

Updates a space.

Overloads

def update_space(request, options = nil) -> ::Google::Apps::Meet::V2::Space

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

Parameters

request (::Google::Apps::Meet::V2::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_space(space: nil, update_mask: nil) -> ::Google::Apps::Meet::V2::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::V2::Space, ::Hash) — Required. Space to be updated.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided, it defaults to '*' and updates all fields provided in the request, including deleting fields not set in the request.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Apps::Meet::V2::Space)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Apps::Meet::V2::Space)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/apps/meet/v2"

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

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

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

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