Class: Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb

Overview

Client for the GSuiteAddOns service.

A service for managing Google Workspace add-ons deployments.

A Google Workspace add-on is a third-party embedded component that can be installed in Google Workspace Applications like Gmail, Calendar, Drive, and the Google Docs, Sheets, and Slides editors. Google Workspace add-ons can display UI cards, receive contextual information from the host application, and perform actions in the host application (See: https://developers.google.com/gsuite/add-ons/overview for more information).

A Google Workspace add-on deployment resource specifies metadata about the add-on, including a specification of the entry points in the host application that trigger add-on executions (see: https://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests). Add-on deployments defined via the Google Workspace add-ons API define their entrypoints using HTTPS URLs (See: https://developers.google.com/gsuite/add-ons/guides/alternate-runtimes),

A Google Workspace add-on deployment can be installed in developer mode, which allows an add-on developer to test the experience an end-user would see when installing and running the add-on in their G Suite applications. When running in developer mode, more detailed error messages are exposed in the add-on UI to aid in debugging.

A Google Workspace add-on deployment can be published to Google Workspace Marketplace, which allows other Google Workspace users to discover and install the add-on. See: https://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview for details.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#authorization_path, #deployment_path, #install_status_path, #project_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new GSuiteAddOns client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the GSuiteAddOns client.

Yield Parameters:


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 162

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/gsuiteaddons/v1/gsuiteaddons_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @g_suite_add_ons_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @g_suite_add_ons_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the GSuiteAddOns Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all GSuiteAddOns clients
::Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 89

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "GSuiteAddOns", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 10.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.get_authorization.timeout = 120.0

    default_config.rpcs.create_deployment.timeout = 10.0

    default_config.rpcs.delete_deployment.timeout = 10.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the GSuiteAddOns 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:


132
133
134
135
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 132

def configure
  yield @config if block_given?
  @config
end

#create_deployment(request, options = nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Deployment #create_deployment(parent: nil, deployment_id: nil, deployment: nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Deployment

Creates a deployment with the specified name and configuration.

Examples:

Basic example

require "google/cloud/gsuite_add_ons/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GSuiteAddOns::V1::CreateDeploymentRequest.new

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

# The returned object is of type Google::Cloud::GSuiteAddOns::V1::Deployment.
p result

Overloads:

  • #create_deployment(request, options = nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Deployment

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

    Parameters:

    • request (::Google::Cloud::GSuiteAddOns::V1::CreateDeploymentRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_deployment(parent: nil, deployment_id: nil, deployment: nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Deployment

    Pass arguments to create_deployment 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:

    • parent (::String) (defaults to: nil) —

      Required. Name of the project in which to create the deployment.

      Example: projects/my_project.

    • deployment_id (::String) (defaults to: nil) —

      Required. The id to use for this deployment. The full name of the created resource will be projects/<project_number>/deployments/<deployment_id>.

    • deployment (::Google::Cloud::GSuiteAddOns::V1::Deployment, ::Hash) (defaults to: nil) —

      Required. The deployment to create (deployment.name cannot be set).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.


363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 363

def create_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GSuiteAddOns::V1::CreateDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GSuiteAddOns::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @g_suite_add_ons_stub.call_rpc :create_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_deployment(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_deployment(name: nil, etag: nil) ⇒ ::Google::Protobuf::Empty

Deletes the deployment with the given name.

Examples:

Basic example

require "google/cloud/gsuite_add_ons/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GSuiteAddOns::V1::DeleteDeploymentRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_deployment(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

    • request (::Google::Cloud::GSuiteAddOns::V1::DeleteDeploymentRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_deployment(name: nil, etag: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_deployment 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:

    • name (::String) (defaults to: nil) —

      Required. The full resource name of the deployment to delete.

      Example: projects/my_project/deployments/my_deployment.

    • etag (::String) (defaults to: nil) —

      The etag of the deployment to delete. If this is provided, it must match the server's etag.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.


729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 729

def delete_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GSuiteAddOns::V1::DeleteDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GSuiteAddOns::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @g_suite_add_ons_stub.call_rpc :delete_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_authorization(request, options = nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Authorization #get_authorization(name: nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Authorization

Gets the authorization information for deployments in a given project.

Examples:

Basic example

require "google/cloud/gsuite_add_ons/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GSuiteAddOns::V1::GetAuthorizationRequest.new

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

# The returned object is of type Google::Cloud::GSuiteAddOns::V1::Authorization.
p result

Overloads:

  • #get_authorization(request, options = nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Authorization

    Pass arguments to get_authorization via a request object, either of type Google::Cloud::GSuiteAddOns::V1::GetAuthorizationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::GSuiteAddOns::V1::GetAuthorizationRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_authorization(name: nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Authorization

    Pass arguments to get_authorization 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:

    • name (::String) (defaults to: nil) —

      Required. Name of the project for which to get the Google Workspace add-ons authorization information.

      Example: projects/my_project/authorization.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.


271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 271

def get_authorization request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GSuiteAddOns::V1::GetAuthorizationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_authorization.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GSuiteAddOns::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_authorization.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_authorization.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @g_suite_add_ons_stub.call_rpc :get_authorization, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_deployment(request, options = nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Deployment #get_deployment(name: nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Deployment

Gets the deployment with the specified name.

Examples:

Basic example

require "google/cloud/gsuite_add_ons/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GSuiteAddOns::V1::GetDeploymentRequest.new

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

# The returned object is of type Google::Cloud::GSuiteAddOns::V1::Deployment.
p result

Overloads:

  • #get_deployment(request, options = nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Deployment

    Pass arguments to get_deployment via a request object, either of type Google::Cloud::GSuiteAddOns::V1::GetDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::GSuiteAddOns::V1::GetDeploymentRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_deployment(name: nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Deployment

    Pass arguments to get_deployment 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:

    • name (::String) (defaults to: nil) —

      Required. The full resource name of the deployment to get.

      Example: projects/my_project/deployments/my_deployment.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.


535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 535

def get_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GSuiteAddOns::V1::GetDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GSuiteAddOns::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @g_suite_add_ons_stub.call_rpc :get_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_install_status(request, options = nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::InstallStatus #get_install_status(name: nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::InstallStatus

Fetches the install status of a developer mode deployment.

Examples:

Basic example

require "google/cloud/gsuite_add_ons/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GSuiteAddOns::V1::GetInstallStatusRequest.new

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

# The returned object is of type Google::Cloud::GSuiteAddOns::V1::InstallStatus.
p result

Overloads:

  • #get_install_status(request, options = nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::InstallStatus

    Pass arguments to get_install_status via a request object, either of type Google::Cloud::GSuiteAddOns::V1::GetInstallStatusRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::GSuiteAddOns::V1::GetInstallStatusRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_install_status(name: nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::InstallStatus

    Pass arguments to get_install_status 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:

    • name (::String) (defaults to: nil) —

      Required. The full resource name of the deployment.

      Example: projects/my_project/deployments/my_deployment/installStatus.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.


994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 994

def get_install_status request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GSuiteAddOns::V1::GetInstallStatusRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_install_status.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GSuiteAddOns::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_install_status.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_install_status.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @g_suite_add_ons_stub.call_rpc :get_install_status, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#install_deployment(request, options = nil) ⇒ ::Google::Protobuf::Empty #install_deployment(name: nil) ⇒ ::Google::Protobuf::Empty

Installs a deployment in developer mode. See: https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.

Examples:

Basic example

require "google/cloud/gsuite_add_ons/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GSuiteAddOns::V1::InstallDeploymentRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #install_deployment(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

    • request (::Google::Cloud::GSuiteAddOns::V1::InstallDeploymentRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #install_deployment(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to install_deployment 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:

    • name (::String) (defaults to: nil) —

      Required. The full resource name of the deployment to install.

      Example: projects/my_project/deployments/my_deployment.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 818

def install_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GSuiteAddOns::V1::InstallDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.install_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GSuiteAddOns::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.install_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.install_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @g_suite_add_ons_stub.call_rpc :install_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_deployments(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::GSuiteAddOns::V1::Deployment> #list_deployments(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::GSuiteAddOns::V1::Deployment>

Lists all deployments in a particular project.

Examples:

Basic example

require "google/cloud/gsuite_add_ons/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GSuiteAddOns::V1::ListDeploymentsRequest.new

# Call the list_deployments method.
result = client.list_deployments 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::Cloud::GSuiteAddOns::V1::Deployment.
  p item
end

Overloads:

  • #list_deployments(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::GSuiteAddOns::V1::Deployment>

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

    Parameters:

    • request (::Google::Cloud::GSuiteAddOns::V1::ListDeploymentsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_deployments(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::GSuiteAddOns::V1::Deployment>

    Pass arguments to list_deployments 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:

    • parent (::String) (defaults to: nil) —

      Required. Name of the project in which to create the deployment.

      Example: projects/my_project.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 1000 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

    • page_token (::String) (defaults to: nil) —

      A page token, received from a previous ListDeployments call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListDeployments must match the call that provided the page token.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.


637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 637

def list_deployments request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GSuiteAddOns::V1::ListDeploymentsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_deployments.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GSuiteAddOns::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_deployments.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_deployments.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @g_suite_add_ons_stub.call_rpc :list_deployments, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @g_suite_add_ons_stub, :list_deployments, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 

218
219
220
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 218

def logger
  @g_suite_add_ons_stub.logger
end

#replace_deployment(request, options = nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Deployment #replace_deployment(deployment: nil) ⇒ ::Google::Cloud::GSuiteAddOns::V1::Deployment

Creates or replaces a deployment with the specified name.

Examples:

Basic example

require "google/cloud/gsuite_add_ons/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GSuiteAddOns::V1::ReplaceDeploymentRequest.new

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

# The returned object is of type Google::Cloud::GSuiteAddOns::V1::Deployment.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 448

def replace_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GSuiteAddOns::V1::ReplaceDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.replace_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GSuiteAddOns::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.deployment&.name
    header_params["deployment.name"] = request.deployment.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.replace_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.replace_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @g_suite_add_ons_stub.call_rpc :replace_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#uninstall_deployment(request, options = nil) ⇒ ::Google::Protobuf::Empty #uninstall_deployment(name: nil) ⇒ ::Google::Protobuf::Empty

Uninstalls a developer mode deployment. See: https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.

Examples:

Basic example

require "google/cloud/gsuite_add_ons/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GSuiteAddOns::V1::UninstallDeploymentRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #uninstall_deployment(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

    • request (::Google::Cloud::GSuiteAddOns::V1::UninstallDeploymentRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #uninstall_deployment(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to uninstall_deployment 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:

    • name (::String) (defaults to: nil) —

      Required. The full resource name of the deployment to install.

      Example: projects/my_project/deployments/my_deployment.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.


907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 907

def uninstall_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GSuiteAddOns::V1::UninstallDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.uninstall_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GSuiteAddOns::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.uninstall_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.uninstall_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @g_suite_add_ons_stub.call_rpc :uninstall_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 

142
143
144
 
# File 'lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb', line 142

def universe_domain
  @g_suite_add_ons_stub.universe_domain
end