class Google::Apis::GroupssettingsV1::GroupssettingsService

Groups Settings API

Manages permission levels and related settings of a group.

@example

require 'google/apis/groupssettings_v1'

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

@see developers.google.com/google-apps/groups-settings/get_started

Attributes

key[RW]

@return [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.
quota_user[RW]

@return [String]

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

@return [String]

Deprecated. Please use quotaUser instead.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/groupssettings_v1/service.rb, line 49
def initialize
  super('https://www.googleapis.com/', 'groups/v1/groups/',
        client_name: 'google-apis-groupssettings_v1',
        client_version: Google::Apis::GroupssettingsV1::GEM_VERSION)
  @batch_path = 'batch/groupssettings/v1'
end

Public Instance Methods

get_group(group_unique_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) click to toggle source

Gets one resource by id. @param [String] group_unique_id

The group's email address.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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

@param [String] user_ip

Deprecated. Please use quotaUser instead.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::GroupssettingsV1::Groups] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::GroupssettingsV1::Groups]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/groupssettings_v1/service.rb, line 78
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, &block) click to toggle source

Updates an existing resource. This method supports patch semantics. @param [String] group_unique_id

The group's email address.

@param [Google::Apis::GroupssettingsV1::Groups] groups_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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

@param [String] user_ip

Deprecated. Please use quotaUser instead.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::GroupssettingsV1::Groups] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::GroupssettingsV1::Groups]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/groupssettings_v1/service.rb, line 113
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, &block) click to toggle source

Updates an existing resource. @param [String] group_unique_id

The group's email address.

@param [Google::Apis::GroupssettingsV1::Groups] groups_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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

@param [String] user_ip

Deprecated. Please use quotaUser instead.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::GroupssettingsV1::Groups] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::GroupssettingsV1::Groups]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/groupssettings_v1/service.rb, line 150
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

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/groupssettings_v1/service.rb, line 166
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
end