Class: Google::Apis::GroupssettingsV1::GroupssettingsService

Inherits:

Core::BaseService

• Object
• Core::BaseService
• Google::Apis::GroupssettingsV1::GroupssettingsService

Defined in:

generated/google/apis/groupssettings_v1/service.rb

Overview

Groups Settings API

Lets you manage permission levels and related settings of a group.

Examples:

require 'google/apis/groupssettings_v1'

Groupssettings = Google::Apis::GroupssettingsV1 # Alias the module
service = Groupssettings::GroupssettingsService.new

See Also:

• https://developers.google.com/google-apps/groups-settings/get_started

Instance Attribute Summary

• #key ⇒ String

  API key.

• #quota_user ⇒ String

  An opaque string that represents a user for quota purposes.

• #user_ip ⇒ String

  Deprecated.

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary

• #get_group(group_unique_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GroupssettingsV1::Groups

  Gets one resource by id.

• #initialize ⇒ GroupssettingsService constructor

  A new instance of GroupssettingsService.

• #patch_group(group_unique_id, groups_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GroupssettingsV1::Groups

  Updates an existing resource.

• #update_group(group_unique_id, groups_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GroupssettingsV1::Groups

  Updates an existing resource.

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ GroupssettingsService

Returns a new instance of GroupssettingsService

# File 'generated/google/apis/groupssettings_v1/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'groups/v1/groups/')
  @batch_path = 'batch/groupssettings/v1'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

• (String) —

  API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

# File 'generated/google/apis/groupssettings_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

• (String) —

  An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

# File 'generated/google/apis/groupssettings_v1/service.rb', line 43

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

• (String) —

  Deprecated. Please use quotaUser instead.

# File 'generated/google/apis/groupssettings_v1/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#get_group(group_unique_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GroupssettingsV1::Groups

Gets one resource by id.

Parameters:

• group_unique_id (String) —

  The resource ID

• fields (String) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) —

  An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

• user_ip (String) —

  Deprecated. Please use quotaUser instead.

• options (Google::Apis::RequestOptions) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GroupssettingsV1::Groups) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GroupssettingsV1::Groups)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'generated/google/apis/groupssettings_v1/service.rb', line 76

def get_group(group_unique_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{groupUniqueId}', options)
  command.query['alt'] = 'json'
  command.response_representation = Google::Apis::GroupssettingsV1::Groups::Representation
  command.response_class = Google::Apis::GroupssettingsV1::Groups
  command.params['groupUniqueId'] = group_unique_id unless group_unique_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_group(group_unique_id, groups_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GroupssettingsV1::Groups

Updates an existing resource. This method supports patch semantics.

Parameters:

• group_unique_id (String) —

  The resource ID

• groups_object (Google::Apis::GroupssettingsV1::Groups) (defaults to: nil)
• fields (String) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) —

  An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

• user_ip (String) —

  Deprecated. Please use quotaUser instead.

• options (Google::Apis::RequestOptions) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GroupssettingsV1::Groups) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GroupssettingsV1::Groups)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'generated/google/apis/groupssettings_v1/service.rb', line 111

def patch_group(group_unique_id, groups_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{groupUniqueId}', options)
  command.request_representation = Google::Apis::GroupssettingsV1::Groups::Representation
  command.request_object = groups_object
  command.query['alt'] = 'json'
  command.response_representation = Google::Apis::GroupssettingsV1::Groups::Representation
  command.response_class = Google::Apis::GroupssettingsV1::Groups
  command.params['groupUniqueId'] = group_unique_id unless group_unique_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_group(group_unique_id, groups_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GroupssettingsV1::Groups

Updates an existing resource.

Parameters:

• group_unique_id (String) —

  The resource ID

• groups_object (Google::Apis::GroupssettingsV1::Groups) (defaults to: nil)
• fields (String) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) —

  An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

• user_ip (String) —

  Deprecated. Please use quotaUser instead.

• options (Google::Apis::RequestOptions) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::GroupssettingsV1::Groups) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::GroupssettingsV1::Groups)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'generated/google/apis/groupssettings_v1/service.rb', line 148

def update_group(group_unique_id, groups_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{groupUniqueId}', options)
  command.request_representation = Google::Apis::GroupssettingsV1::Groups::Representation
  command.request_object = groups_object
  command.query['alt'] = 'json'
  command.response_representation = Google::Apis::GroupssettingsV1::Groups::Representation
  command.response_class = Google::Apis::GroupssettingsV1::Groups
  command.params['groupUniqueId'] = group_unique_id unless group_unique_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end