diff --git a/generated/google/apis/admin_reports_v1.rb b/generated/google/apis/admin_reports_v1.rb index 9af0b8942..142cd32d8 100644 --- a/generated/google/apis/admin_reports_v1.rb +++ b/generated/google/apis/admin_reports_v1.rb @@ -23,10 +23,10 @@ module Google # Fetches reports for the administrators of G Suite customers about the usage, # collaboration, security, and risk for their users. # - # @see https://developers.google.com/admin-sdk/reports/ + # @see /admin-sdk/reports/ module AdminReportsV1 VERSION = 'ReportsV1' - REVISION = '20190521' + REVISION = '20191003' # View audit reports for your G Suite domain AUTH_ADMIN_REPORTS_AUDIT_READONLY = 'https://www.googleapis.com/auth/admin.reports.audit.readonly' diff --git a/generated/google/apis/admin_reports_v1/classes.rb b/generated/google/apis/admin_reports_v1/classes.rb index 61490b44b..264eda2d0 100644 --- a/generated/google/apis/admin_reports_v1/classes.rb +++ b/generated/google/apis/admin_reports_v1/classes.rb @@ -31,17 +31,19 @@ module Google # @return [String] attr_accessor :etag - # Each record in read response. + # Each activity record in the response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # Kind of list response this is. + # The type of API resource. For an activity report, the value is reports# + # activities. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Token for retrieving the next page + # Token for retrieving the follow-on next page of the report. The nextPageToken + # value is used in the request's pageToken query string. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -73,7 +75,7 @@ module Google # @return [String] attr_accessor :etag - # Activity events. + # Activity events in the report. # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events @@ -83,17 +85,22 @@ module Google # @return [Google::Apis::AdminReportsV1::Activity::Id] attr_accessor :id - # IP Address of the user doing the action. + # IP address of the user doing the action. This is the Internet Protocol (IP) + # address of the user when logging into G Suite which may or may not reflect the + # user's physical location. For example, the IP address can be the user's proxy + # server's address or a virtual private network (VPN) address. The API supports + # IPv4 and IPv6. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address - # Kind of resource this is. + # The type of API resource. For an activity report, the value is audit#activity. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Domain of source customer. + # This is the domain that is affected by the report's event. For example domain + # of Admin console or the Drive application's document owner. # Corresponds to the JSON property `ownerDomain` # @return [String] attr_accessor :owner_domain @@ -117,22 +124,25 @@ module Google class Actor include Google::Apis::Core::Hashable - # User or OAuth 2LO request. + # The type of actor. # Corresponds to the JSON property `callerType` # @return [String] attr_accessor :caller_type - # Email address of the user. + # The primary email address of the actor. May be absent if there is no email + # address associated with the actor. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email - # For OAuth 2LO API requests, consumer_key of the requestor. + # Only present when callerType is KEY. Can be the consumer_key of the requestor + # for OAuth 2LO API requests or an identifier for robot accounts. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # Obfuscated user id of the user. + # The unique G Suite profile ID of the actor. May be absent if the actor is not + # a G Suite user. # Corresponds to the JSON property `profileId` # @return [String] attr_accessor :profile_id @@ -154,17 +164,32 @@ module Google class Event include Google::Apis::Core::Hashable - # Name of event. + # Name of the event. This is the specific name of the activity reported by the + # API. And each eventName is related to a specific G Suite service or feature + # which the API organizes into types of events. + # For eventName request parameters in general: + # - If no eventName is given, the report returns all possible instances of an + # eventName. + # - When you request an eventName, the API's response returns all activities + # which contain that eventName. It is possible that the returned activities will + # have other eventName properties in addition to the one requested. + # For more information about eventName properties, see the list of event names + # for various applications above in applicationName. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Parameter value pairs for various applications. + # Parameter value pairs for various applications. For more information about + # eventName parameters, see the list of event names for various applications + # above in applicationName. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters - # Type of event. + # Type of event. The G Suite service or feature that an administrator changes is + # identified in the type property which identifies an event using the eventName + # property. For a full list of the API's type categories, see the list of event + # names for various applications above in applicationName. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -190,27 +215,30 @@ module Google attr_accessor :bool_value alias_method :bool_value?, :bool_value - # Integral value of the parameter. + # Integer value of the parameter. # Corresponds to the JSON property `intValue` # @return [Fixnum] attr_accessor :int_value - # Nested value of the parameter. + # Nested parameter value pairs associated with this parameter. Complex value + # type for a parameter are returned as a list of parameter values. For example, + # the address parameter may have a value as [`parameter: [`name: city, value: + # abc`]`] # Corresponds to the JSON property `messageValue` # @return [Google::Apis::AdminReportsV1::Activity::Event::Parameter::MessageValue] attr_accessor :message_value - # Multi-int value of the parameter. + # Integer values of the parameter. # Corresponds to the JSON property `multiIntValue` # @return [Array] attr_accessor :multi_int_value - # Nested values of the parameter. + # List of messageValue objects. # Corresponds to the JSON property `multiMessageValue` # @return [Array] attr_accessor :multi_message_value - # Multi-string value of the parameter. + # String values of the parameter. # Corresponds to the JSON property `multiValue` # @return [Array] attr_accessor :multi_value @@ -241,11 +269,14 @@ module Google @value = args[:value] if args.key?(:value) end - # Nested value of the parameter. + # Nested parameter value pairs associated with this parameter. Complex value + # type for a parameter are returned as a list of parameter values. For example, + # the address parameter may have a value as [`parameter: [`name: city, value: + # abc`]`] class MessageValue include Google::Apis::Core::Hashable - # Looping to get parameter values. + # Parameter values # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter @@ -264,7 +295,7 @@ module Google class MultiMessageValue include Google::Apis::Core::Hashable - # Parameter value. + # Parameter values # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter @@ -285,17 +316,18 @@ module Google class Id include Google::Apis::Core::Hashable - # Application name to which the event belongs. + # Application name to which the event belongs. For possible values see the list + # of applications above in applicationName. # Corresponds to the JSON property `applicationName` # @return [String] attr_accessor :application_name - # Obfuscated customer ID of the source customer. + # The unique identifier for a G suite account. # Corresponds to the JSON property `customerId` # @return [String] attr_accessor :customer_id - # Time of occurrence of the activity. + # Time of occurrence of the activity. This is in UNIX epoch time in seconds. # Corresponds to the JSON property `time` # @return [DateTime] attr_accessor :time @@ -407,7 +439,7 @@ module Google attr_accessor :bool_value alias_method :bool_value?, :bool_value - # Integral value of the parameter. + # Integer value of the parameter. # Corresponds to the JSON property `intValue` # @return [Fixnum] attr_accessor :int_value @@ -417,7 +449,7 @@ module Google # @return [Array] attr_accessor :multi_bool_value - # Multiple integral values of the parameter. + # Multiple integer values of the parameter. # Corresponds to the JSON property `multiIntValue` # @return [Array] attr_accessor :multi_int_value @@ -457,7 +489,7 @@ module Google class UsageReport include Google::Apis::Core::Hashable - # The date to which the record belongs. + # The date of the report request. # Corresponds to the JSON property `date` # @return [String] attr_accessor :date @@ -472,12 +504,14 @@ module Google # @return [String] attr_accessor :etag - # The kind of object. + # The type of API resource. For a usage report, the value is admin#reports# + # usageReport. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Parameter value pairs for various applications. + # Parameter value pairs for various applications. For the Customers usage report + # parameters and values, see the customer usage parameters reference. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters @@ -499,7 +533,7 @@ module Google class Entity include Google::Apis::Core::Hashable - # Obfuscated customer id for the record. + # The unique identifier of the customer's account. # Corresponds to the JSON property `customerId` # @return [String] attr_accessor :customer_id @@ -510,17 +544,17 @@ module Google # @return [String] attr_accessor :entity_id - # Obfuscated user id for the record. + # The user's immutable G Suite profile identifier. # Corresponds to the JSON property `profileId` # @return [String] attr_accessor :profile_id - # The type of item, can be customer, user, or entity (aka. object). + # The type of item. The value is customer. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # user's email. Only relevant if entity.type = "USER" + # The user's email address. Only relevant if entity.type = "USER" # Corresponds to the JSON property `userEmail` # @return [String] attr_accessor :user_email @@ -549,12 +583,13 @@ module Google attr_accessor :bool_value alias_method :bool_value?, :bool_value - # RFC 3339 formatted value of the parameter. + # The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35. + # 000Z. # Corresponds to the JSON property `datetimeValue` # @return [DateTime] attr_accessor :datetime_value - # Integral value of the parameter. + # Integer value of the parameter. # Corresponds to the JSON property `intValue` # @return [Fixnum] attr_accessor :int_value @@ -564,7 +599,7 @@ module Google # @return [Array>] attr_accessor :msg_value - # The name of the parameter. + # # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -590,7 +625,7 @@ module Google end end - # JSON template for a collection of usage reports. + # class UsageReports include Google::Apis::Core::Hashable @@ -599,12 +634,15 @@ module Google # @return [String] attr_accessor :etag - # The kind of object. + # The type of API resource. For a usage report, the value is admin#reports# + # usageReports. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Token for retrieving the next page + # Token to specify next page. A report with multiple pages has a nextPageToken + # property in the response. For your follow-on requests getting all of the + # report's pages, enter the nextPageToken value in the pageToken query string. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -614,7 +652,7 @@ module Google # @return [Array] attr_accessor :usage_reports - # Warnings if any. + # Warnings, if any. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings @@ -636,17 +674,22 @@ module Google class Warning include Google::Apis::Core::Hashable - # Machine readable code / warning type. + # Machine readable code or warning type. The warning code value is 200. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # Key-Value pairs to give detailed information on the warning. + # Key-value pairs to give detailed information on the warning. # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # Human readable message for the warning. + # The human readable messages for a warning are: + # - Data is not available warning - Sorry, data for date yyyy-mm-dd for + # application "application name" is not available. + # - Partial data is available warning - Data for date yyyy-mm-dd for application + # "application name" is not available right now, please try again after a few + # hours. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message diff --git a/generated/google/apis/admin_reports_v1/service.rb b/generated/google/apis/admin_reports_v1/service.rb index 3f40a2cbb..664528dd8 100644 --- a/generated/google/apis/admin_reports_v1/service.rb +++ b/generated/google/apis/admin_reports_v1/service.rb @@ -31,7 +31,7 @@ module Google # Admin = Google::Apis::AdminReportsV1 # Alias the module # service = Admin::ReportsService.new # - # @see https://developers.google.com/admin-sdk/reports/ + # @see /admin-sdk/reports/ class ReportsService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -52,34 +52,108 @@ module Google @batch_path = 'batch/admin/reports_v1' end - # Retrieves a list of activities for a specific customer and application. + # Retrieves a list of activities for a specific customer's account and + # application such as the Admin console application or the Google Drive + # application. For more information, see the guides for administrator and Google + # Drive activity reports. For more information about the activity report's + # parameters, see the activity parameters reference guides. # @param [String] user_key - # Represents the profile id or the user email for which the data should be - # filtered. When 'all' is specified as the userKey, it returns usageReports for - # all users. + # Represents the profile ID or the user email for which the data should be + # filtered. # @param [String] application_name # Application name for which the events are to be retrieved. # @param [String] actor_ip_address - # IP Address of host where the event was performed. Supports both IPv4 and IPv6 - # addresses. + # The Internet Protocol (IP) Address of host where the event was performed. This + # is an additional way to filter a report's summary using the IP address of the + # user whose activity is being reported. This IP address may or may not reflect + # the user's physical location. For example, the IP address can be the user's + # proxy server's address or a virtual private network (VPN) address. This + # parameter supports both IPv4 and IPv6 address versions. # @param [String] customer_id - # Represents the customer for which the data is to be fetched. + # The unique ID of the customer to retrieve data for. # @param [String] end_time - # Return events which occurred at or before this time. + # Sets the end of the range of time shown in the report. The date is in the RFC + # 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the + # approximate time of the API request. An API report has three basic time + # concepts: + # - Date of the API's request for a report: When the API created and retrieved + # the report. + # - Report's start time: The beginning of the timespan shown in the report. The + # startTime must be before the endTime (if specified) and the current time when + # the request is made, or the API returns an error. + # - Report's end time: The end of the timespan shown in the report. For example, + # the timespan of events summarized in a report can start in April and end in + # May. The report itself can be requested in August. If the endTime is not + # specified, the report returns all activities from the startTime until the + # current time or the most recent 180 days if the startTime is more than 180 + # days in the past. # @param [String] event_name - # Name of the event being queried. + # The name of the event being queried by the API. Each eventName is related to a + # specific G Suite service or feature which the API organizes into types of + # events. An example is the Google Calendar events in the Admin console + # application's reports. The Calendar Settings type structure has all of the + # Calendar eventName activities reported by the API. When an administrator + # changes a Calendar setting, the API reports this activity in the Calendar + # Settings type and eventName parameters. For more information about eventName + # query strings and parameters, see the list of event names for various + # applications above in applicationName. # @param [String] filters - # Event parameters in the form [parameter1 name][operator][parameter1 value],[ - # parameter2 name][operator][parameter2 value],... + # The filters query string is a comma-separated list. The list is composed of + # event parameters that are manipulated by relational operators. Event + # parameters are in the form [parameter1 name][relational operator][parameter1 + # value],[parameter2 name][relational operator][parameter2 value],... + # These event parameters are associated with a specific eventName. An empty + # report is returned if the filtered request's parameter does not belong to the + # eventName. For more information about eventName parameters, see the list of + # event names for various applications above in applicationName. + # In the following Admin Activity example, the <> operator is URL-encoded in the + # request's query string (%3C%3E): + # GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C% + # 3EREAD_ONLY_ACCESS + # In the following Drive example, the list can be a view or edit event's doc_id + # parameter with a value that is manipulated by an 'equal to' (==) or 'not equal + # to' (<>) relational operator. In the first example, the report returns each + # edited document's doc_id. In the second example, the report returns each + # viewed document's doc_id that equals the value 12345 and does not return any + # viewed document's which have a doc_id value of 98765. The <> operator is URL- + # encoded in the request's query string (%3C%3E): + # GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id== + # 12345,doc_id%3C%3E98765 + # The relational operators include: + # - == - 'equal to'. + # - <> - 'not equal to'. It is URL-encoded (%3C%3E). + # - < - 'less than'. It is URL-encoded (%3C). + # - <= - 'less than or equal to'. It is URL-encoded (%3C=). + # - > - 'greater than'. It is URL-encoded (%3E). + # - >= - 'greater than or equal to'. It is URL-encoded (%3E=). + # Note: The API doesn't accept multiple values of a parameter. If a particular + # parameter is supplied more than once in the API request, the API only accepts + # the last value of that request parameter. + # In addition, if an invalid request parameter is supplied in the API request, + # the API ignores that request parameter and returns the response corresponding + # to the remaining valid request parameters. If no parameters are requested, all + # parameters are returned. # @param [Fixnum] max_results - # Number of activity records to be shown in each page. + # Determines how many activity records are shown on each response page. For + # example, if the request sets maxResults=1 and the report has two activities, + # the report has two pages. The response's nextPageToken property has the token + # to the second page. The maxResults query string is optional in the request. + # The default value is 1000. # @param [String] org_unit_id - # the organizational unit's(OU) ID to filter activities from users belonging to - # a specific OU or one of its sub-OU(s) + # ID of the organizational unit to report on. Activity records will be shown + # only for users who belong to the specified organizational unit. Data before + # Dec 17, 2018 doesn't appear in the filtered results. # @param [String] page_token - # Token to specify next page. + # The token to specify next page. A report with multiple pages has a + # nextPageToken property in the response. In your follow-on request getting the + # next page of the report, enter the nextPageToken value in the pageToken query + # string. # @param [String] start_time - # Return events which occurred at or after this time. + # Sets the beginning of the range of time shown in the report. The date is in + # the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns + # all activities from startTime until endTime. The startTime must be before the + # endTime (if specified) and the current time when the request is made, or the + # API returns an error. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -120,35 +194,106 @@ module Google execute_or_queue_command(command, &block) end - # Push changes to activities + # Start receiving notifications for account activities. For more information, + # see Receiving Push Notifications. # @param [String] user_key - # Represents the profile id or the user email for which the data should be - # filtered. When 'all' is specified as the userKey, it returns usageReports for - # all users. + # Represents the profile ID or the user email for which the data should be + # filtered. # @param [String] application_name # Application name for which the events are to be retrieved. # @param [Google::Apis::AdminReportsV1::Channel] channel_object # @param [String] actor_ip_address - # IP Address of host where the event was performed. Supports both IPv4 and IPv6 - # addresses. + # The Internet Protocol (IP) Address of host where the event was performed. This + # is an additional way to filter a report's summary using the IP address of the + # user whose activity is being reported. This IP address may or may not reflect + # the user's physical location. For example, the IP address can be the user's + # proxy server's address or a virtual private network (VPN) address. This + # parameter supports both IPv4 and IPv6 address versions. # @param [String] customer_id - # Represents the customer for which the data is to be fetched. + # The unique ID of the customer to retrieve data for. # @param [String] end_time - # Return events which occurred at or before this time. + # Sets the end of the range of time shown in the report. The date is in the RFC + # 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the + # approximate time of the API request. An API report has three basic time + # concepts: + # - Date of the API's request for a report: When the API created and retrieved + # the report. + # - Report's start time: The beginning of the timespan shown in the report. The + # startTime must be before the endTime (if specified) and the current time when + # the request is made, or the API returns an error. + # - Report's end time: The end of the timespan shown in the report. For example, + # the timespan of events summarized in a report can start in April and end in + # May. The report itself can be requested in August. If the endTime is not + # specified, the report returns all activities from the startTime until the + # current time or the most recent 180 days if the startTime is more than 180 + # days in the past. # @param [String] event_name - # Name of the event being queried. + # The name of the event being queried by the API. Each eventName is related to a + # specific G Suite service or feature which the API organizes into types of + # events. An example is the Google Calendar events in the Admin console + # application's reports. The Calendar Settings type structure has all of the + # Calendar eventName activities reported by the API. When an administrator + # changes a Calendar setting, the API reports this activity in the Calendar + # Settings type and eventName parameters. For more information about eventName + # query strings and parameters, see the list of event names for various + # applications above in applicationName. # @param [String] filters - # Event parameters in the form [parameter1 name][operator][parameter1 value],[ - # parameter2 name][operator][parameter2 value],... + # The filters query string is a comma-separated list. The list is composed of + # event parameters that are manipulated by relational operators. Event + # parameters are in the form [parameter1 name][relational operator][parameter1 + # value],[parameter2 name][relational operator][parameter2 value],... + # These event parameters are associated with a specific eventName. An empty + # report is returned if the filtered request's parameter does not belong to the + # eventName. For more information about eventName parameters, see the list of + # event names for various applications above in applicationName. + # In the following Admin Activity example, the <> operator is URL-encoded in the + # request's query string (%3C%3E): + # GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C% + # 3EREAD_ONLY_ACCESS + # In the following Drive example, the list can be a view or edit event's doc_id + # parameter with a value that is manipulated by an 'equal to' (==) or 'not equal + # to' (<>) relational operator. In the first example, the report returns each + # edited document's doc_id. In the second example, the report returns each + # viewed document's doc_id that equals the value 12345 and does not return any + # viewed document's which have a doc_id value of 98765. The <> operator is URL- + # encoded in the request's query string (%3C%3E): + # GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id== + # 12345,doc_id%3C%3E98765 + # The relational operators include: + # - == - 'equal to'. + # - <> - 'not equal to'. It is URL-encoded (%3C%3E). + # - < - 'less than'. It is URL-encoded (%3C). + # - <= - 'less than or equal to'. It is URL-encoded (%3C=). + # - > - 'greater than'. It is URL-encoded (%3E). + # - >= - 'greater than or equal to'. It is URL-encoded (%3E=). + # Note: The API doesn't accept multiple values of a parameter. If a particular + # parameter is supplied more than once in the API request, the API only accepts + # the last value of that request parameter. + # In addition, if an invalid request parameter is supplied in the API request, + # the API ignores that request parameter and returns the response corresponding + # to the remaining valid request parameters. If no parameters are requested, all + # parameters are returned. # @param [Fixnum] max_results - # Number of activity records to be shown in each page. + # Determines how many activity records are shown on each response page. For + # example, if the request sets maxResults=1 and the report has two activities, + # the report has two pages. The response's nextPageToken property has the token + # to the second page. The maxResults query string is optional in the request. + # The default value is 1000. # @param [String] org_unit_id - # the organizational unit's(OU) ID to filter activities from users belonging to - # a specific OU or one of its sub-OU(s) + # ID of the organizational unit to report on. Activity records will be shown + # only for users who belong to the specified organizational unit. Data before + # Dec 17, 2018 doesn't appear in the filtered results. # @param [String] page_token - # Token to specify next page. + # The token to specify next page. A report with multiple pages has a + # nextPageToken property in the response. In your follow-on request getting the + # next page of the report, enter the nextPageToken value in the pageToken query + # string. # @param [String] start_time - # Return events which occurred at or after this time. + # Sets the beginning of the range of time shown in the report. The date is in + # the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns + # all activities from startTime until endTime. The startTime must be before the + # endTime (if specified) and the current time when the request is made, or the + # API returns an error. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -222,17 +367,35 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a report which is a collection of properties / statistics for a - # specific customer. + # Retrieves a report which is a collection of properties and statistics for a + # specific customer's account. For more information, see the Customers Usage + # Report guide. For more information about the customer report's parameters, see + # the Customers Usage parameters reference guides. # @param [String] date - # Represents the date in yyyy-mm-dd format for which the data is to be fetched. + # Represents the date the usage occurred. The timestamp is in the ISO 8601 + # format, yyyy-mm-dd. We recommend you use your account's time zone for this. # @param [String] customer_id - # Represents the customer for which the data is to be fetched. + # The unique ID of the customer to retrieve data for. # @param [String] page_token - # Token to specify next page. + # Token to specify next page. A report with multiple pages has a nextPageToken + # property in the response. For your follow-on requests getting all of the + # report's pages, enter the nextPageToken value in the pageToken query string. # @param [String] parameters - # Represents the application name, parameter name pairs to fetch in csv as - # app_name1:param_name1, app_name2:param_name2. + # The parameters query string is a comma-separated list of event parameters that + # refine a report's results. The parameter is associated with a specific + # application. The application values for the Customers usage report include + # accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, + # gplus, device_management, meet, and sites. + # A parameters query string is in the CSV form of app_name1:param_name1, + # app_name2:param_name2. + # Note: The API doesn't accept multiple values of a parameter. If a particular + # parameter is supplied more than once in the API request, the API only accepts + # the last value of that request parameter. + # In addition, if an invalid request parameter is supplied in the API request, + # the API ignores that request parameter and returns the response corresponding + # to the remaining valid request parameters. + # An example of an invalid request parameter is one that does not belong to the + # application. If no parameters are requested, all parameters are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -266,25 +429,64 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a report which is a collection of properties / statistics for a set - # of objects. + # Retrieves a report which is a collection of properties and statistics for + # entities used by users within the account. For more information, see the + # Entities Usage Report guide. For more information about the entities report's + # parameters, see the Entities Usage parameters reference guides. # @param [String] entity_type - # Type of object. Should be one of - gplus_communities. + # Represents the type of entity for the report. # @param [String] entity_key - # Represents the key of object for which the data should be filtered. + # Represents the key of the object to filter the data with. # @param [String] date - # Represents the date in yyyy-mm-dd format for which the data is to be fetched. + # Represents the date the usage occurred. The timestamp is in the ISO 8601 + # format, yyyy-mm-dd. We recommend you use your account's time zone for this. # @param [String] customer_id - # Represents the customer for which the data is to be fetched. + # The unique ID of the customer to retrieve data for. # @param [String] filters - # Represents the set of filters including parameter operator value. + # The filters query string is a comma-separated list of an application's event + # parameters where the parameter's value is manipulated by a relational operator. + # The filters query string includes the name of the application whose usage is + # returned in the report. The application values for the Entities usage report + # include accounts, docs, and gmail. + # Filters are in the form [application name]:[parameter name][relational + # operator][parameter value],.... + # In this example, the <> 'not equal to' operator is URL-encoded in the request' + # s query string (%3C%3E): + # GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/ + # dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members & + # filters=gplus:num_total_members>0 + # The relational operators include: + # - == - 'equal to'. + # - <> - 'not equal to'. It is URL-encoded (%3C%3E). + # - < - 'less than'. It is URL-encoded (%3C). + # - <= - 'less than or equal to'. It is URL-encoded (%3C=). + # - > - 'greater than'. It is URL-encoded (%3E). + # - >= - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only + # be applied to numeric parameters. # @param [Fixnum] max_results - # Maximum number of results to return. Maximum allowed is 1000 + # Determines how many activity records are shown on each response page. For + # example, if the request sets maxResults=1 and the report has two activities, + # the report has two pages. The response's nextPageToken property has the token + # to the second page. # @param [String] page_token - # Token to specify next page. + # Token to specify next page. A report with multiple pages has a nextPageToken + # property in the response. In your follow-on request getting the next page of + # the report, enter the nextPageToken value in the pageToken query string. # @param [String] parameters - # Represents the application name, parameter name pairs to fetch in csv as - # app_name1:param_name1, app_name2:param_name2. + # The parameters query string is a comma-separated list of event parameters that + # refine a report's results. The parameter is associated with a specific + # application. The application values for the Entities usage report are only + # gplus. + # A parameter query string is in the CSV form of [app_name1:param_name1], [ + # app_name2:param_name2].... + # Note: The API doesn't accept multiple values of a parameter. If a particular + # parameter is supplied more than once in the API request, the API only accepts + # the last value of that request parameter. + # In addition, if an invalid request parameter is supplied in the API request, + # the API ignores that request parameter and returns the response corresponding + # to the remaining valid request parameters. + # An example of an invalid request parameter is one that does not belong to the + # application. If no parameters are requested, all parameters are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -322,27 +524,68 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a report which is a collection of properties / statistics for a set - # of users. + # Retrieves a report which is a collection of properties and statistics for a + # set of users with the account. For more information, see the User Usage Report + # guide. For more information about the user report's parameters, see the Users + # Usage parameters reference guides. # @param [String] user_key - # Represents the profile id or the user email for which the data should be + # Represents the profile ID or the user email for which the data should be # filtered. # @param [String] date - # Represents the date in yyyy-mm-dd format for which the data is to be fetched. + # Represents the date the usage occurred. The timestamp is in the ISO 8601 + # format, yyyy-mm-dd. We recommend you use your account's time zone for this. # @param [String] customer_id - # Represents the customer for which the data is to be fetched. + # The unique ID of the customer to retrieve data for. # @param [String] filters - # Represents the set of filters including parameter operator value. + # The filters query string is a comma-separated list of an application's event + # parameters where the parameter's value is manipulated by a relational operator. + # The filters query string includes the name of the application whose usage is + # returned in the report. The application values for the Users Usage Report + # include accounts, docs, and gmail. + # Filters are in the form [application name]:[parameter name][relational + # operator][parameter value],.... + # In this example, the <> 'not equal to' operator is URL-encoded in the request' + # s query string (%3C%3E): + # GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03- + # 03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time>2010- + # 10-28T10:26:35.000Z + # The relational operators include: + # - == - 'equal to'. + # - <> - 'not equal to'. It is URL-encoded (%3C%3E). + # - < - 'less than'. It is URL-encoded (%3C). + # - <= - 'less than or equal to'. It is URL-encoded (%3C=). + # - > - 'greater than'. It is URL-encoded (%3E). + # - >= - 'greater than or equal to'. It is URL-encoded (%3E=). # @param [Fixnum] max_results - # Maximum number of results to return. Maximum allowed is 1000 + # Determines how many activity records are shown on each response page. For + # example, if the request sets maxResults=1 and the report has two activities, + # the report has two pages. The response's nextPageToken property has the token + # to the second page. + # The maxResults query string is optional. # @param [String] org_unit_id - # the organizational unit's ID to filter usage parameters from users belonging - # to a specific OU or one of its sub-OU(s). + # ID of the organizational unit to report on. User activity will be shown only + # for users who belong to the specified organizational unit. Data before Dec 17, + # 2018 doesn't appear in the filtered results. # @param [String] page_token - # Token to specify next page. + # Token to specify next page. A report with multiple pages has a nextPageToken + # property in the response. In your follow-on request getting the next page of + # the report, enter the nextPageToken value in the pageToken query string. # @param [String] parameters - # Represents the application name, parameter name pairs to fetch in csv as - # app_name1:param_name1, app_name2:param_name2. + # The parameters query string is a comma-separated list of event parameters that + # refine a report's results. The parameter is associated with a specific + # application. The application values for the Customers usage report include + # accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, + # gplus, device_management, meet, and sites. + # A parameters query string is in the CSV form of app_name1:param_name1, + # app_name2:param_name2. + # Note: The API doesn't accept multiple values of a parameter. + # If a particular parameter is supplied more than once in the API request, the + # API only accepts the last value of that request parameter. In addition, if an + # invalid request parameter is supplied in the API request, the API ignores that + # request parameter and returns the response corresponding to the remaining + # valid request parameters. + # An example of an invalid request parameter is one that does not belong to the + # application. If no parameters are requested, all parameters are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/cloudbilling_v1.rb b/generated/google/apis/cloudbilling_v1.rb index ef5e65c85..6939e1a44 100644 --- a/generated/google/apis/cloudbilling_v1.rb +++ b/generated/google/apis/cloudbilling_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/billing/ module CloudbillingV1 VERSION = 'V1' - REVISION = '20190805' + REVISION = '20191005' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbilling_v1/classes.rb b/generated/google/apis/cloudbilling_v1/classes.rb index 22db28b53..abbf5c386 100644 --- a/generated/google/apis/cloudbilling_v1/classes.rb +++ b/generated/google/apis/cloudbilling_v1/classes.rb @@ -155,14 +155,6 @@ module Google # @return [Array] attr_accessor :exempted_members - # Specifies whether principals can be exempted for the same LogType in - # lower-level resource policies. If true, any lower-level exemptions will - # be ignored. - # Corresponds to the JSON property `ignoreChildExemptions` - # @return [Boolean] - attr_accessor :ignore_child_exemptions - alias_method :ignore_child_exemptions?, :ignore_child_exemptions - # The log type that this config enables. # Corresponds to the JSON property `logType` # @return [String] @@ -175,7 +167,6 @@ module Google # Update properties of this object def update!(**args) @exempted_members = args[:exempted_members] if args.key?(:exempted_members) - @ignore_child_exemptions = args[:ignore_child_exemptions] if args.key?(:ignore_child_exemptions) @log_type = args[:log_type] if args.key?(:log_type) end end @@ -512,25 +503,34 @@ module Google # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. - # A `Policy` consists of a list of `bindings`. A `binding` binds a list of - # `members` to a `role`, where the members can be user accounts, Google groups, - # Google domains, and service accounts. A `role` is a named list of permissions - # defined by IAM. + # A `Policy` is a collection of `bindings`. A `binding` binds one or more + # `members` to a single `role`. Members can be user accounts, service accounts, + # Google groups, and domains (such as G Suite). A `role` is a named list of + # permissions (defined by IAM or configured by users). A `binding` can + # optionally specify a `condition`, which is a logic expression that further + # constrains the role binding based on attributes about the request and/or + # target resource. # **JSON Example** # ` # "bindings": [ # ` - # "role": "roles/owner", + # "role": "roles/resourcemanager.organizationAdmin", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", - # "serviceAccount:my-other-app@appspot.gserviceaccount.com" + # "serviceAccount:my-project-id@appspot.gserviceaccount.com" # ] # `, # ` - # "role": "roles/viewer", - # "members": ["user:sean@example.com"] + # "role": "roles/resourcemanager.organizationViewer", + # "members": ["user:eve@example.com"], + # "condition": ` + # "title": "expirable access", + # "description": "Does not grant access after Sep 2020", + # "expression": "request.time < + # timestamp('2020-10-01T00:00:00.000Z')", + # ` # ` # ] # ` @@ -540,11 +540,15 @@ module Google # - user:mike@example.com # - group:admins@example.com # - domain:google.com - # - serviceAccount:my-other-app@appspot.gserviceaccount.com - # role: roles/owner + # - serviceAccount:my-project-id@appspot.gserviceaccount.com + # role: roles/resourcemanager.organizationAdmin # - members: - # - user:sean@example.com - # role: roles/viewer + # - user:eve@example.com + # role: roles/resourcemanager.organizationViewer + # condition: + # title: expirable access + # description: Does not grant access after Sep 2020 + # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). class Policy @@ -555,7 +559,8 @@ module Google # @return [Array] attr_accessor :audit_configs - # Associates a list of `members` to a `role`. + # Associates a list of `members` to a `role`. Optionally may specify a + # `condition` that determines when binding is in effect. # `bindings` with no members will result in an error. # Corresponds to the JSON property `bindings` # @return [Array] @@ -569,13 +574,24 @@ module Google # systems are expected to put that etag in the request to `setIamPolicy` to # ensure that their change will be applied to the same version of the policy. # If no `etag` is provided in the call to `setIamPolicy`, then the existing - # policy is overwritten. + # policy is overwritten. Due to blind-set semantics of an etag-less policy, + # 'setIamPolicy' will not fail even if either of incoming or stored policy + # does not meet the version requirements. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # Deprecated. + # Specifies the format of the policy. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. + # Operations affecting conditional bindings must specify version 3. This can + # be either setting a conditional policy, modifying a conditional binding, + # or removing a conditional binding from the stored conditional policy. + # Operations on non-conditional policies may specify any valid value or + # leave the field unset. + # If no etag is provided in the call to `setIamPolicy`, any version + # compliance checks on the incoming and/or stored policy is skipped. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -827,25 +843,34 @@ module Google # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. - # A `Policy` consists of a list of `bindings`. A `binding` binds a list of - # `members` to a `role`, where the members can be user accounts, Google groups, - # Google domains, and service accounts. A `role` is a named list of permissions - # defined by IAM. + # A `Policy` is a collection of `bindings`. A `binding` binds one or more + # `members` to a single `role`. Members can be user accounts, service accounts, + # Google groups, and domains (such as G Suite). A `role` is a named list of + # permissions (defined by IAM or configured by users). A `binding` can + # optionally specify a `condition`, which is a logic expression that further + # constrains the role binding based on attributes about the request and/or + # target resource. # **JSON Example** # ` # "bindings": [ # ` - # "role": "roles/owner", + # "role": "roles/resourcemanager.organizationAdmin", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", - # "serviceAccount:my-other-app@appspot.gserviceaccount.com" + # "serviceAccount:my-project-id@appspot.gserviceaccount.com" # ] # `, # ` - # "role": "roles/viewer", - # "members": ["user:sean@example.com"] + # "role": "roles/resourcemanager.organizationViewer", + # "members": ["user:eve@example.com"], + # "condition": ` + # "title": "expirable access", + # "description": "Does not grant access after Sep 2020", + # "expression": "request.time < + # timestamp('2020-10-01T00:00:00.000Z')", + # ` # ` # ] # ` @@ -855,11 +880,15 @@ module Google # - user:mike@example.com # - group:admins@example.com # - domain:google.com - # - serviceAccount:my-other-app@appspot.gserviceaccount.com - # role: roles/owner + # - serviceAccount:my-project-id@appspot.gserviceaccount.com + # role: roles/resourcemanager.organizationAdmin # - members: - # - user:sean@example.com - # role: roles/viewer + # - user:eve@example.com + # role: roles/resourcemanager.organizationViewer + # condition: + # title: expirable access + # description: Does not grant access after Sep 2020 + # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). # Corresponds to the JSON property `policy` diff --git a/generated/google/apis/cloudbilling_v1/representations.rb b/generated/google/apis/cloudbilling_v1/representations.rb index f156cc29b..34b720483 100644 --- a/generated/google/apis/cloudbilling_v1/representations.rb +++ b/generated/google/apis/cloudbilling_v1/representations.rb @@ -176,7 +176,6 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation collection :exempted_members, as: 'exemptedMembers' - property :ignore_child_exemptions, as: 'ignoreChildExemptions' property :log_type, as: 'logType' end end diff --git a/generated/google/apis/cloudbilling_v1/service.rb b/generated/google/apis/cloudbilling_v1/service.rb index 17b3e73f6..09a6d2916 100644 --- a/generated/google/apis/cloudbilling_v1/service.rb +++ b/generated/google/apis/cloudbilling_v1/service.rb @@ -129,9 +129,11 @@ module Google # See the operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version # Optional. The policy format version to be returned. - # Acceptable values are 0, 1, and 3. - # If the value is 0, or the field is omitted, policy format version 1 will be - # returned. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. + # Requests for policies with any conditional bindings must specify version 3. + # Policies without any conditional bindings may specify any valid value or + # leave the field unset. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/datafusion_v1beta1.rb b/generated/google/apis/datafusion_v1beta1.rb index 8711112dc..1bb594813 100644 --- a/generated/google/apis/datafusion_v1beta1.rb +++ b/generated/google/apis/datafusion_v1beta1.rb @@ -34,7 +34,7 @@ module Google # @see https://cloud.google.com/data-fusion/docs module DatafusionV1beta1 VERSION = 'V1beta1' - REVISION = '20190610' + REVISION = '20191007' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/datafusion_v1beta1/classes.rb b/generated/google/apis/datafusion_v1beta1/classes.rb index 480977e11..96c19075a 100644 --- a/generated/google/apis/datafusion_v1beta1/classes.rb +++ b/generated/google/apis/datafusion_v1beta1/classes.rb @@ -39,7 +39,7 @@ module Google # ` # "log_type": "DATA_READ", # "exempted_members": [ - # "user:foo@gmail.com" + # "user:jose@example.com" # ] # `, # ` @@ -51,7 +51,7 @@ module Google # ] # `, # ` - # "service": "fooservice.googleapis.com" + # "service": "sampleservice.googleapis.com" # "audit_log_configs": [ # ` # "log_type": "DATA_READ", @@ -59,16 +59,16 @@ module Google # ` # "log_type": "DATA_WRITE", # "exempted_members": [ - # "user:bar@gmail.com" + # "user:aliya@example.com" # ] # ` # ] # ` # ] # ` - # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ - # logging. It also exempts foo@gmail.com from DATA_READ logging, and - # bar@gmail.com from DATA_WRITE logging. + # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ + # logging. It also exempts jose@example.com from DATA_READ logging, and + # aliya@example.com from DATA_WRITE logging. class AuditConfig include Google::Apis::Core::Hashable @@ -108,7 +108,7 @@ module Google # ` # "log_type": "DATA_READ", # "exempted_members": [ - # "user:foo@gmail.com" + # "user:jose@example.com" # ] # `, # ` @@ -117,7 +117,7 @@ module Google # ] # ` # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - # foo@gmail.com from DATA_READ logging. + # jose@example.com from DATA_READ logging. class AuditLogConfig include Google::Apis::Core::Hashable @@ -128,6 +128,12 @@ module Google # @return [Array] attr_accessor :exempted_members + # + # Corresponds to the JSON property `ignoreChildExemptions` + # @return [Boolean] + attr_accessor :ignore_child_exemptions + alias_method :ignore_child_exemptions?, :ignore_child_exemptions + # The log type that this config enables. # Corresponds to the JSON property `logType` # @return [String] @@ -140,6 +146,7 @@ module Google # Update properties of this object def update!(**args) @exempted_members = args[:exempted_members] if args.key?(:exempted_members) + @ignore_child_exemptions = args[:ignore_child_exemptions] if args.key?(:ignore_child_exemptions) @log_type = args[:log_type] if args.key?(:log_type) end end @@ -182,7 +189,7 @@ module Google # * `allAuthenticatedUsers`: A special identifier that represents anyone # who is authenticated with a Google account or a service account. # * `user:`emailid``: An email address that represents a specific Google - # account. For example, `alice@gmail.com` . + # account. For example, `alice@example.com` . # * `serviceAccount:`emailid``: An email address that represents a service # account. For example, `my-other-app@appspot.gserviceaccount.com`. # * `group:`emailid``: An email address that represents a Google group. @@ -308,13 +315,16 @@ module Google # - "" (empty string), resulting in a counter with no fields. # Examples: # counter ` metric: "/debug_access_count" field: "iam_principal" ` - # ==> increment counter /iam/policy/backend_debug_access_count + # ==> increment counter /iam/policy/debug_access_count # `iam_principal=[value of IAMContext.principal]` - # At this time we do not support multiple field names (though this may be - # supported in the future). class CounterOptions include Google::Apis::Core::Hashable + # Custom fields. + # Corresponds to the JSON property `customFields` + # @return [Array] + attr_accessor :custom_fields + # The field value to attribute. # Corresponds to the JSON property `field` # @return [String] @@ -331,11 +341,42 @@ module Google # Update properties of this object def update!(**args) + @custom_fields = args[:custom_fields] if args.key?(:custom_fields) @field = args[:field] if args.key?(:field) @metric = args[:metric] if args.key?(:metric) end end + # Custom fields. + # These can be used to create a counter with arbitrary field/value + # pairs. + # See: go/rpcsp-custom-fields. + class CustomField + include Google::Apis::Core::Hashable + + # Name is the field name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Value is the field value. It is important that in contrast to the + # CounterOptions.field, the value here is a constant that is not + # derived from the IAMContext. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @value = args[:value] if args.key?(:value) + end + end + # Write a Data Access (Gin) log class DataAccessOptions include Google::Apis::Core::Hashable @@ -426,6 +467,17 @@ module Google class Instance include Google::Apis::Core::Hashable + # Output only. Endpoint on which the REST APIs is accessible. + # Corresponds to the JSON property `apiEndpoint` + # @return [String] + attr_accessor :api_endpoint + + # Available versions that the instance can be upgraded to using + # UpdateInstanceRequest. + # Corresponds to the JSON property `availableVersion` + # @return [Array] + attr_accessor :available_version + # Output only. The time the instance was created. # Corresponds to the JSON property `createTime` # @return [String] @@ -496,8 +548,7 @@ module Google # @return [String] attr_accessor :service_account - # Output only. Endpoint on which the Data Fusion UI and REST APIs are - # accessible. + # Output only. Endpoint on which the Data Fusion UI is accessible. # Corresponds to the JSON property `serviceEndpoint` # @return [String] attr_accessor :service_endpoint @@ -523,7 +574,7 @@ module Google # @return [String] attr_accessor :update_time - # Output only. Current version of the Data Fusion. + # Current version of the Data Fusion. Only specifiable in Update. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -539,6 +590,8 @@ module Google # Update properties of this object def update!(**args) + @api_endpoint = args[:api_endpoint] if args.key?(:api_endpoint) + @available_version = args[:available_version] if args.key?(:available_version) @create_time = args[:create_time] if args.key?(:create_time) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @@ -713,10 +766,8 @@ module Google # - "" (empty string), resulting in a counter with no fields. # Examples: # counter ` metric: "/debug_access_count" field: "iam_principal" ` - # ==> increment counter /iam/policy/backend_debug_access_count + # ==> increment counter /iam/policy/debug_access_count # `iam_principal=[value of IAMContext.principal]` - # At this time we do not support multiple field names (though this may be - # supported in the future). # Corresponds to the JSON property `counter` # @return [Google::Apis::DatafusionV1beta1::CounterOptions] attr_accessor :counter @@ -755,7 +806,9 @@ module Google attr_accessor :ip_allocation # Name of the network in the customer project with which the Tenant Project - # will be peered for executing pipelines. + # will be peered for executing pipelines. In case of shared VPC where the + # network resides in another host project the network should specified in + # the form of projects/`host-project-id`/global/networks/`network` # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -896,25 +949,34 @@ module Google # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. - # A `Policy` consists of a list of `bindings`. A `binding` binds a list of - # `members` to a `role`, where the members can be user accounts, Google groups, - # Google domains, and service accounts. A `role` is a named list of permissions - # defined by IAM. + # A `Policy` is a collection of `bindings`. A `binding` binds one or more + # `members` to a single `role`. Members can be user accounts, service accounts, + # Google groups, and domains (such as G Suite). A `role` is a named list of + # permissions (defined by IAM or configured by users). A `binding` can + # optionally specify a `condition`, which is a logic expression that further + # constrains the role binding based on attributes about the request and/or + # target resource. # **JSON Example** # ` # "bindings": [ # ` - # "role": "roles/owner", + # "role": "roles/resourcemanager.organizationAdmin", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", - # "serviceAccount:my-other-app@appspot.gserviceaccount.com" + # "serviceAccount:my-project-id@appspot.gserviceaccount.com" # ] # `, # ` - # "role": "roles/viewer", - # "members": ["user:sean@example.com"] + # "role": "roles/resourcemanager.organizationViewer", + # "members": ["user:eve@example.com"], + # "condition": ` + # "title": "expirable access", + # "description": "Does not grant access after Sep 2020", + # "expression": "request.time < + # timestamp('2020-10-01T00:00:00.000Z')", + # ` # ` # ] # ` @@ -924,11 +986,15 @@ module Google # - user:mike@example.com # - group:admins@example.com # - domain:google.com - # - serviceAccount:my-other-app@appspot.gserviceaccount.com - # role: roles/owner + # - serviceAccount:my-project-id@appspot.gserviceaccount.com + # role: roles/resourcemanager.organizationAdmin # - members: - # - user:sean@example.com - # role: roles/viewer + # - user:eve@example.com + # role: roles/resourcemanager.organizationViewer + # condition: + # title: expirable access + # description: Does not grant access after Sep 2020 + # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). class Policy @@ -939,7 +1005,8 @@ module Google # @return [Array] attr_accessor :audit_configs - # Associates a list of `members` to a `role`. + # Associates a list of `members` to a `role`. Optionally may specify a + # `condition` that determines when binding is in effect. # `bindings` with no members will result in an error. # Corresponds to the JSON property `bindings` # @return [Array] @@ -953,7 +1020,9 @@ module Google # systems are expected to put that etag in the request to `setIamPolicy` to # ensure that their change will be applied to the same version of the policy. # If no `etag` is provided in the call to `setIamPolicy`, then the existing - # policy is overwritten blindly. + # policy is overwritten. Due to blind-set semantics of an etag-less policy, + # 'setIamPolicy' will not fail even if either of incoming or stored policy + # does not meet the version requirements. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -978,7 +1047,16 @@ module Google # @return [Array] attr_accessor :rules - # Deprecated. + # Specifies the format of the policy. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. + # Operations affecting conditional bindings must specify version 3. This can + # be either setting a conditional policy, modifying a conditional binding, + # or removing a conditional binding from the stored conditional policy. + # Operations on non-conditional policies may specify any valid value or + # leave the field unset. + # If no etag is provided in the call to `setIamPolicy`, any version + # compliance checks on the incoming and/or stored policy is skipped. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -1080,25 +1158,34 @@ module Google # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. - # A `Policy` consists of a list of `bindings`. A `binding` binds a list of - # `members` to a `role`, where the members can be user accounts, Google groups, - # Google domains, and service accounts. A `role` is a named list of permissions - # defined by IAM. + # A `Policy` is a collection of `bindings`. A `binding` binds one or more + # `members` to a single `role`. Members can be user accounts, service accounts, + # Google groups, and domains (such as G Suite). A `role` is a named list of + # permissions (defined by IAM or configured by users). A `binding` can + # optionally specify a `condition`, which is a logic expression that further + # constrains the role binding based on attributes about the request and/or + # target resource. # **JSON Example** # ` # "bindings": [ # ` - # "role": "roles/owner", + # "role": "roles/resourcemanager.organizationAdmin", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", - # "serviceAccount:my-other-app@appspot.gserviceaccount.com" + # "serviceAccount:my-project-id@appspot.gserviceaccount.com" # ] # `, # ` - # "role": "roles/viewer", - # "members": ["user:sean@example.com"] + # "role": "roles/resourcemanager.organizationViewer", + # "members": ["user:eve@example.com"], + # "condition": ` + # "title": "expirable access", + # "description": "Does not grant access after Sep 2020", + # "expression": "request.time < + # timestamp('2020-10-01T00:00:00.000Z')", + # ` # ` # ] # ` @@ -1108,11 +1195,15 @@ module Google # - user:mike@example.com # - group:admins@example.com # - domain:google.com - # - serviceAccount:my-other-app@appspot.gserviceaccount.com - # role: roles/owner + # - serviceAccount:my-project-id@appspot.gserviceaccount.com + # role: roles/resourcemanager.organizationAdmin # - members: - # - user:sean@example.com - # role: roles/viewer + # - user:eve@example.com + # role: roles/resourcemanager.organizationViewer + # condition: + # title: expirable access + # description: Does not grant access after Sep 2020 + # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). # Corresponds to the JSON property `policy` @@ -1233,6 +1324,25 @@ module Google def update!(**args) end end + + # The Data Fusion version. + class Version + include Google::Apis::Core::Hashable + + # The version number of the Data Fusion instance, such as '6.0.1.0'. + # Corresponds to the JSON property `versionNumber` + # @return [String] + attr_accessor :version_number + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @version_number = args[:version_number] if args.key?(:version_number) + end + end end end end diff --git a/generated/google/apis/datafusion_v1beta1/representations.rb b/generated/google/apis/datafusion_v1beta1/representations.rb index 7b1276282..378d8119d 100644 --- a/generated/google/apis/datafusion_v1beta1/representations.rb +++ b/generated/google/apis/datafusion_v1beta1/representations.rb @@ -70,6 +70,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class CustomField + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class DataAccessOptions class Representation < Google::Apis::Core::JsonRepresentation; end @@ -190,6 +196,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Version + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AuditConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -204,6 +216,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation collection :exempted_members, as: 'exemptedMembers' + property :ignore_child_exemptions, as: 'ignoreChildExemptions' property :log_type, as: 'logType' end end @@ -254,11 +267,21 @@ module Google class CounterOptions # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :custom_fields, as: 'customFields', class: Google::Apis::DatafusionV1beta1::CustomField, decorator: Google::Apis::DatafusionV1beta1::CustomField::Representation + property :field, as: 'field' property :metric, as: 'metric' end end + class CustomField + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :value, as: 'value' + end + end + class DataAccessOptions # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -285,6 +308,9 @@ module Google class Instance # @private class Representation < Google::Apis::Core::JsonRepresentation + property :api_endpoint, as: 'apiEndpoint' + collection :available_version, as: 'availableVersion', class: Google::Apis::DatafusionV1beta1::Version, decorator: Google::Apis::DatafusionV1beta1::Version::Representation + property :create_time, as: 'createTime' property :description, as: 'description' property :display_name, as: 'displayName' @@ -464,6 +490,13 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation end end + + class Version + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :version_number, as: 'versionNumber' + end + end end end end diff --git a/generated/google/apis/datafusion_v1beta1/service.rb b/generated/google/apis/datafusion_v1beta1/service.rb index 96f18394b..6b2b65632 100644 --- a/generated/google/apis/datafusion_v1beta1/service.rb +++ b/generated/google/apis/datafusion_v1beta1/service.rb @@ -230,6 +230,13 @@ module Google # @param [String] resource # REQUIRED: The resource for which the policy is being requested. # See the operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. + # Requests for policies with any conditional bindings must specify version 3. + # Policies without any conditional bindings may specify any valid value or + # leave the field unset. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -247,11 +254,12 @@ module Google # @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 - def get_project_location_instance_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) + def get_project_location_instance_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+resource}:getIamPolicy', options) command.response_representation = Google::Apis::DatafusionV1beta1::Policy::Representation command.response_class = Google::Apis::DatafusionV1beta1::Policy command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -382,6 +390,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. + # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. diff --git a/generated/google/apis/securitycenter_v1.rb b/generated/google/apis/securitycenter_v1.rb index bf4ce47d8..ea10a150e 100644 --- a/generated/google/apis/securitycenter_v1.rb +++ b/generated/google/apis/securitycenter_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1 VERSION = 'V1' - REVISION = '20190920' + REVISION = '20191004' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/securitycenter_v1/classes.rb b/generated/google/apis/securitycenter_v1/classes.rb index 07ff1576e..5e7a55e3a 100644 --- a/generated/google/apis/securitycenter_v1/classes.rb +++ b/generated/google/apis/securitycenter_v1/classes.rb @@ -1210,7 +1210,7 @@ module Google # ` # "bindings": [ # ` - # "role": "role/resourcemanager.organizationAdmin", + # "role": "roles/resourcemanager.organizationAdmin", # "members": [ # "user:mike@example.com", # "group:admins@example.com", @@ -1449,7 +1449,7 @@ module Google # ` # "bindings": [ # ` - # "role": "role/resourcemanager.organizationAdmin", + # "role": "roles/resourcemanager.organizationAdmin", # "members": [ # "user:mike@example.com", # "group:admins@example.com", diff --git a/generated/google/apis/securitycenter_v1beta1.rb b/generated/google/apis/securitycenter_v1beta1.rb index f27d1d3f4..f3706cb50 100644 --- a/generated/google/apis/securitycenter_v1beta1.rb +++ b/generated/google/apis/securitycenter_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1beta1 VERSION = 'V1beta1' - REVISION = '20190920' + REVISION = '20191004' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/securitycenter_v1beta1/classes.rb b/generated/google/apis/securitycenter_v1beta1/classes.rb index 630964b2e..19cceddaf 100644 --- a/generated/google/apis/securitycenter_v1beta1/classes.rb +++ b/generated/google/apis/securitycenter_v1beta1/classes.rb @@ -1086,7 +1086,7 @@ module Google # ` # "bindings": [ # ` - # "role": "role/resourcemanager.organizationAdmin", + # "role": "roles/resourcemanager.organizationAdmin", # "members": [ # "user:mike@example.com", # "group:admins@example.com", @@ -1325,7 +1325,7 @@ module Google # ` # "bindings": [ # ` - # "role": "role/resourcemanager.organizationAdmin", + # "role": "roles/resourcemanager.organizationAdmin", # "members": [ # "user:mike@example.com", # "group:admins@example.com", diff --git a/generated/google/apis/serviceconsumermanagement_v1.rb b/generated/google/apis/serviceconsumermanagement_v1.rb index 30405fbf9..b70fa8d60 100644 --- a/generated/google/apis/serviceconsumermanagement_v1.rb +++ b/generated/google/apis/serviceconsumermanagement_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/service-consumer-management/docs/overview module ServiceconsumermanagementV1 VERSION = 'V1' - REVISION = '20190920' + REVISION = '20191004' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/serviceconsumermanagement_v1/classes.rb b/generated/google/apis/serviceconsumermanagement_v1/classes.rb index d91520a23..5aa3ef536 100644 --- a/generated/google/apis/serviceconsumermanagement_v1/classes.rb +++ b/generated/google/apis/serviceconsumermanagement_v1/classes.rb @@ -3809,6 +3809,27 @@ module Google end end + # Response message for the `GenerateServiceIdentity` method. + # This response message is assigned to the `response` field of the returned + # Operation when that operation is done. + class V1Beta1GenerateServiceIdentityResponse + include Google::Apis::Core::Hashable + + # A service identity in the Identity and Access Management API. + # Corresponds to the JSON property `identity` + # @return [Google::Apis::ServiceconsumermanagementV1::V1Beta1ServiceIdentity] + attr_accessor :identity + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @identity = args[:identity] if args.key?(:identity) + end + end + # Response message for ImportProducerOverrides class V1Beta1ImportProducerOverridesResponse include Google::Apis::Core::Hashable @@ -3912,6 +3933,48 @@ module Google end end + # A service identity in the Identity and Access Management API. + class V1Beta1ServiceIdentity + include Google::Apis::Core::Hashable + + # The email address of the service identity. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # P4 service identity resource name. + # An example name would be: + # `services/serviceconsumermanagement.googleapis.com/projects/123/ + # serviceIdentities/default` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The P4 service identity configuration tag. This must be defined in + # activation_grants. If not specified when creating the account, the tag is + # set to "default". + # Corresponds to the JSON property `tag` + # @return [String] + attr_accessor :tag + + # The unique and stable id of the service identity. + # Corresponds to the JSON property `uniqueId` + # @return [String] + attr_accessor :unique_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @email = args[:email] if args.key?(:email) + @name = args[:name] if args.key?(:name) + @tag = args[:tag] if args.key?(:tag) + @unique_id = args[:unique_id] if args.key?(:unique_id) + end + end + # Response message for the `DisableConsumer` method. # This response message is assigned to the `response` field of the returned # Operation when that operation is done. diff --git a/generated/google/apis/serviceconsumermanagement_v1/representations.rb b/generated/google/apis/serviceconsumermanagement_v1/representations.rb index 3238a0f94..9b4bfca38 100644 --- a/generated/google/apis/serviceconsumermanagement_v1/representations.rb +++ b/generated/google/apis/serviceconsumermanagement_v1/representations.rb @@ -466,6 +466,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class V1Beta1GenerateServiceIdentityResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class V1Beta1ImportProducerOverridesResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -484,6 +490,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class V1Beta1ServiceIdentity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class V1DisableConsumerResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1284,6 +1296,14 @@ module Google end end + class V1Beta1GenerateServiceIdentityResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :identity, as: 'identity', class: Google::Apis::ServiceconsumermanagementV1::V1Beta1ServiceIdentity, decorator: Google::Apis::ServiceconsumermanagementV1::V1Beta1ServiceIdentity::Representation + + end + end + class V1Beta1ImportProducerOverridesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1309,6 +1329,16 @@ module Google end end + class V1Beta1ServiceIdentity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :email, as: 'email' + property :name, as: 'name' + property :tag, as: 'tag' + property :unique_id, as: 'uniqueId' + end + end + class V1DisableConsumerResponse # @private class Representation < Google::Apis::Core::JsonRepresentation