Google Workspace Add-ons V1 API - Class Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Rest::ServiceStub (v1.0.0)

Version 1.0.0

• 1.0.1 (latest)
• 1.0.0
• 0.6.0
• 0.5.2
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Google Workspace Add-ons V1 API class Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Rest::ServiceStub.

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

Inherits

• Object

Methods

#create_deployment

def create_deployment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GSuiteAddOns::V1::Deployment

Baseline implementation for the create_deployment REST call

Parameters

• request_pb (::Google::Cloud::GSuiteAddOns::V1::CreateDeploymentRequest) — 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

• result (::Google::Cloud::GSuiteAddOns::V1::Deployment)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::GSuiteAddOns::V1::Deployment) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_deployment

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

Baseline implementation for the delete_deployment REST call

Parameters

• request_pb (::Google::Cloud::GSuiteAddOns::V1::DeleteDeploymentRequest) — 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

• result (::Google::Protobuf::Empty)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#get_authorization

def get_authorization(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GSuiteAddOns::V1::Authorization

Baseline implementation for the get_authorization REST call

Parameters

• request_pb (::Google::Cloud::GSuiteAddOns::V1::GetAuthorizationRequest) — 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

• result (::Google::Cloud::GSuiteAddOns::V1::Authorization)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::GSuiteAddOns::V1::Authorization) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_deployment

def get_deployment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GSuiteAddOns::V1::Deployment

Baseline implementation for the get_deployment REST call

Parameters

• request_pb (::Google::Cloud::GSuiteAddOns::V1::GetDeploymentRequest) — 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

• result (::Google::Cloud::GSuiteAddOns::V1::Deployment)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::GSuiteAddOns::V1::Deployment) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_install_status

def get_install_status(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GSuiteAddOns::V1::InstallStatus

Baseline implementation for the get_install_status REST call

Parameters

• request_pb (::Google::Cloud::GSuiteAddOns::V1::GetInstallStatusRequest) — 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

• result (::Google::Cloud::GSuiteAddOns::V1::InstallStatus)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::GSuiteAddOns::V1::InstallStatus) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

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

Returns

• (ServiceStub) — a new instance of ServiceStub

#install_deployment

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

Baseline implementation for the install_deployment REST call

Parameters

• request_pb (::Google::Cloud::GSuiteAddOns::V1::InstallDeploymentRequest) — 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

• result (::Google::Protobuf::Empty)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_deployments

def list_deployments(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GSuiteAddOns::V1::ListDeploymentsResponse

Baseline implementation for the list_deployments REST call

Parameters

• request_pb (::Google::Cloud::GSuiteAddOns::V1::ListDeploymentsRequest) — 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

• result (::Google::Cloud::GSuiteAddOns::V1::ListDeploymentsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::GSuiteAddOns::V1::ListDeploymentsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#replace_deployment

def replace_deployment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::GSuiteAddOns::V1::Deployment

Baseline implementation for the replace_deployment REST call

Parameters

• request_pb (::Google::Cloud::GSuiteAddOns::V1::ReplaceDeploymentRequest) — 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

• result (::Google::Cloud::GSuiteAddOns::V1::Deployment)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::GSuiteAddOns::V1::Deployment) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#uninstall_deployment

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

Baseline implementation for the uninstall_deployment REST call

Parameters

• request_pb (::Google::Cloud::GSuiteAddOns::V1::UninstallDeploymentRequest) — 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

• result (::Google::Protobuf::Empty)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)