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

Inherits:
Core::BaseService show all
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:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

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

Instance Method Summary collapse

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



51
52
53
54
 
# File 'generated/google/apis/groupssettings_v1/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'groups/v1/groups/')
  @batch_path = 'batch'
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.



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

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (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.



44
45
46
 
# File 'generated/google/apis/groupssettings_v1/service.rb', line 44

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



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

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) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



80
81
82
83
84
85
86
87
88
89
90
 
# File 'generated/google/apis/groupssettings_v1/service.rb', line 80

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) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'generated/google/apis/groupssettings_v1/service.rb', line 117

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) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'generated/google/apis/groupssettings_v1/service.rb', line 156

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