Reference documentation and code samples for the Google Meet V2BETA API class Google::Apps::Meet::V2beta::SpacesService::Rest::Client.
REST 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::Rest::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_member
def create_member(request, options = nil) -> ::Google::Apps::Meet::V2beta::Member
def 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".
def create_member(request, options = nil) -> ::Google::Apps::Meet::V2beta::Member
create_member
via a request object, either of type
CreateMemberRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def create_member(parent: nil, member: nil) -> ::Google::Apps::Meet::V2beta::Member
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).
- parent (::String) — Required. Format: spaces/{space}
- member (::Google::Apps::Meet::V2beta::Member, ::Hash) — Required. The member to be created.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Apps::Meet::V2beta::Member)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call 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::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
#create_space
def create_space(request, options = nil) -> ::Google::Apps::Meet::V2beta::Space
def create_space(space: nil) -> ::Google::Apps::Meet::V2beta::Space
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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Apps::Meet::V2beta::Space)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call 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::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
#delete_member
def delete_member(request, options = nil) -> ::Google::Protobuf::Empty
def delete_member(name: nil) -> ::Google::Protobuf::Empty
Developer Preview: Delete the member who was previously assigned roles in the space.
def delete_member(request, options = nil) -> ::Google::Protobuf::Empty
delete_member
via a request object, either of type
DeleteMemberRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete_member(name: nil) -> ::Google::Protobuf::Empty
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).
- name (::String) — Required. Format: “spaces/{space}/members/{member}”
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call 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::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
#end_active_conference
def end_active_conference(request, options = nil) -> ::Google::Protobuf::Empty
def end_active_conference(name: nil) -> ::Google::Protobuf::Empty
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.
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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call 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::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
#get_member
def get_member(request, options = nil) -> ::Google::Apps::Meet::V2beta::Member
def 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".
def get_member(request, options = nil) -> ::Google::Apps::Meet::V2beta::Member
get_member
via a request object, either of type
GetMemberRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_member(name: nil) -> ::Google::Apps::Meet::V2beta::Member
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).
- name (::String) — Required. Format: “spaces/{space}/members/{member}”
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Apps::Meet::V2beta::Member)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call 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::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
#get_space
def get_space(request, options = nil) -> ::Google::Apps::Meet::V2beta::Space
def get_space(name: nil) -> ::Google::Apps::Meet::V2beta::Space
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.
Format:
spaces/{space}
orspaces/{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, ameetingCode
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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Apps::Meet::V2beta::Space)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call 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::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
#initialize
def initialize() { |config| ... } -> Client
Create a new SpacesService REST 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::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
#list_members
def list_members(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2beta::Member>
def 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".
def list_members(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2beta::Member>
list_members
via a request object, either of type
ListMembersRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list_members(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2beta::Member>
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).
- parent (::String) — Required. Format: spaces/{space}
- page_size (::Integer) — 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) — Optional. Page token returned from previous List Call.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2beta::Member>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2beta::Member>)
- (::Google::Cloud::Error) — if the REST call 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::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
#logger
def logger() -> Logger
The logger used for request/response debug logging.
- (Logger)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#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
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(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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Apps::Meet::V2beta::Space)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call 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::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