Google Chat V1 API - Class Google::Apps::Chat::V1::ChatService::Rest::ServiceStub (v0.5.0)

Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Chat::V1::ChatService::Rest::ServiceStub.

REST service stub for the ChatService service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

  • Object

Methods

#complete_import_space

def complete_import_space(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::CompleteImportSpaceResponse

Baseline implementation for the complete_import_space REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_membership

def create_membership(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Membership

Baseline implementation for the create_membership REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::CreateMembershipRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_message

def create_message(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Message

Baseline implementation for the create_message REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::CreateMessageRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_reaction

def create_reaction(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Reaction

Baseline implementation for the create_reaction REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::CreateReactionRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_space

def create_space(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Space

Baseline implementation for the create_space REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::CreateSpaceRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_membership

def delete_membership(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Membership

Baseline implementation for the delete_membership REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::DeleteMembershipRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_message

def delete_message(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_message REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::DeleteMessageRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_reaction

def delete_reaction(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_reaction REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::DeleteReactionRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_space

def delete_space(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_space REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::DeleteSpaceRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#find_direct_message

def find_direct_message(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Space

Baseline implementation for the find_direct_message REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_attachment

def get_attachment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Attachment

Baseline implementation for the get_attachment REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::GetAttachmentRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_membership

def get_membership(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Membership

Baseline implementation for the get_membership REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::GetMembershipRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_message

def get_message(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Message

Baseline implementation for the get_message REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::GetMessageRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_space

def get_space(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Space

Baseline implementation for the get_space REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::GetSpaceRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_space_event

def get_space_event(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::SpaceEvent

Baseline implementation for the get_space_event REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::GetSpaceEventRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_space_read_state

def get_space_read_state(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::SpaceReadState

Baseline implementation for the get_space_read_state REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_thread_read_state

def get_thread_read_state(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::ThreadReadState

Baseline implementation for the get_thread_read_state REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
Returns

#list_memberships

def list_memberships(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::ListMembershipsResponse

Baseline implementation for the list_memberships REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::ListMembershipsRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_messages

def list_messages(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::ListMessagesResponse

Baseline implementation for the list_messages REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::ListMessagesRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_reactions

def list_reactions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::ListReactionsResponse

Baseline implementation for the list_reactions REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::ListReactionsRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_space_events

def list_space_events(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::ListSpaceEventsResponse

Baseline implementation for the list_space_events REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::ListSpaceEventsRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_spaces

def list_spaces(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::ListSpacesResponse

Baseline implementation for the list_spaces REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::ListSpacesRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#search_spaces

def search_spaces(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::SearchSpacesResponse

Baseline implementation for the search_spaces REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::SearchSpacesRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#set_up_space

def set_up_space(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Space

Baseline implementation for the set_up_space REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::SetUpSpaceRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_membership

def update_membership(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Membership

Baseline implementation for the update_membership REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::UpdateMembershipRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_message

def update_message(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Message

Baseline implementation for the update_message REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::UpdateMessageRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_space

def update_space(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::Space

Baseline implementation for the update_space REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::UpdateSpaceRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_space_read_state

def update_space_read_state(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::SpaceReadState

Baseline implementation for the update_space_read_state REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#upload_attachment

def upload_attachment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Apps::Chat::V1::UploadAttachmentResponse

Baseline implementation for the upload_attachment REST call

Parameters
  • request_pb (::Google::Apps::Chat::V1::UploadAttachmentRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)