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

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/groupssettings_v1/service.rb

Overview

Groups Settings API

Manages 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:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://www.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ GroupssettingsService

Returns a new instance of GroupssettingsService.



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

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, 'groups/v1/groups/',
        client_name: 'google-apis-groupssettings_v1',
        client_version: Google::Apis::GroupssettingsV1::GEM_VERSION)
  @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.



40
41
42
 
# File 'lib/google/apis/groupssettings_v1/service.rb', line 40

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.



45
46
47
 
# File 'lib/google/apis/groupssettings_v1/service.rb', line 45

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String) —

    Deprecated. Please use quotaUser instead.



49
50
51
 
# File 'lib/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 group's email address.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/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 group's email address.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/google/apis/groupssettings_v1/service.rb', line 115

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 group's email address.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/google/apis/groupssettings_v1/service.rb', line 152

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