Reference documentation and code samples for the Google Meet V2BETA API class Google::Apps::Meet::V2beta::SpacesService::Client.
Client for the SpacesService service.
REST API for services dealing with spaces.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the SpacesService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all SpacesService clients ::Google::Apps::Meet::V2beta::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.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_space
def create_space(request, options = nil) -> ::Google::Apps::Meet::V2beta::Space
def create_space(space: nil) -> ::Google::Apps::Meet::V2beta::Space
Developer Preview. Creates a space.
def create_space(request, options = nil) -> ::Google::Apps::Meet::V2beta::Space
create_space
via a request object, either of type
CreateSpaceRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_space(space: nil) -> ::Google::Apps::Meet::V2beta::Space
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).
- space (::Google::Apps::Meet::V2beta::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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Apps::Meet::V2beta::Space)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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
#end_active_conference
def end_active_conference(request, options = nil) -> ::Google::Protobuf::Empty
def end_active_conference(name: nil) -> ::Google::Protobuf::Empty
Developer Preview. Ends an active conference (if there is one).
def end_active_conference(request, options = nil) -> ::Google::Protobuf::Empty
end_active_conference
via a request object, either of type
EndActiveConferenceRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def end_active_conference(name: nil) -> ::Google::Protobuf::Empty
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).
- name (::String) — Required. Resource name of the space.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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
#get_space
def get_space(request, options = nil) -> ::Google::Apps::Meet::V2beta::Space
def get_space(name: nil) -> ::Google::Apps::Meet::V2beta::Space
Developer Preview.
Gets a space by space_id
or meeting_code
.
def get_space(request, options = nil) -> ::Google::Apps::Meet::V2beta::Space
get_space
via a request object, either of type
GetSpaceRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_space(name: nil) -> ::Google::Apps::Meet::V2beta::Space
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).
- name (::String) — Required. Resource name of the space.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Apps::Meet::V2beta::Space)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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
#initialize
def initialize() { |config| ... } -> Client
Create a new SpacesService client object.
- (config) — Configure the SpacesService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Apps::Meet::V2beta::SpacesService::Client.new # Create a client using a custom configuration client = ::Google::Apps::Meet::V2beta::SpacesService::Client.new do |config| config.timeout = 10.0 end
#update_space
def update_space(request, options = nil) -> ::Google::Apps::Meet::V2beta::Space
def update_space(space: nil, update_mask: nil) -> ::Google::Apps::Meet::V2beta::Space
Developer Preview. Updates a space.
def update_space(request, options = nil) -> ::Google::Apps::Meet::V2beta::Space
update_space
via a request object, either of type
UpdateSpaceRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_space(space: nil, update_mask: nil) -> ::Google::Apps::Meet::V2beta::Space
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).
- space (::Google::Apps::Meet::V2beta::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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Apps::Meet::V2beta::Space)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::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