class Google::Apis::GroupssettingsV1::GroupssettingsService
Groups Settings API
Lets you manage 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
@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.
@return [String]
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@return [String]
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Public Class Methods
# File generated/google/apis/groupssettings_v1/service.rb, line 51 def initialize super('https://www.googleapis.com/', 'groups/v1/groups/') end
Public Instance Methods
Gets one resource by id. @param [String] group_unique_id
The resource ID
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@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 generated/google/apis/groupssettings_v1/service.rb, line 79 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
Updates an existing resource. This method supports patch semantics. @param [String] group_unique_id
The resource ID
@param [Google::Apis::GroupssettingsV1::Groups] groups_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@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 generated/google/apis/groupssettings_v1/service.rb, line 116 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
Updates an existing resource. @param [String] group_unique_id
The resource ID
@param [Google::Apis::GroupssettingsV1::Groups] groups_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@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 generated/google/apis/groupssettings_v1/service.rb, line 155 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
# File generated/google/apis/groupssettings_v1/service.rb, line 171 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