google-apis-gkebackup_v1 0.30.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d48b8018ae503ad29113dc3469c2a5af11206bf7abfea4bbf91da4d3a170f6fa
-  data.tar.gz: ba2eea3f8e0fe7fb747dd17fafcad517da02aaf7e6752aa3123c39248497584f
+  metadata.gz: 5ffd01074f0305fdd15539d26643a2d98e8faa2108cc134d8be75b9e7cbb4bba
+  data.tar.gz: c214ea5e03a56e278c49cd76412667c15b6da42ac0417ab6cb1b356f7a5160a0
 SHA512:
-  metadata.gz: ba2efd10bc4c81f0b80d6afdb2509da54949696321c9a3d3a6d81e51f510a8e1745ab8447de69f77f1c94b58cd8ecd8205af170aad265ba04a916f844beec854
-  data.tar.gz: 9f74c944eeefd8d3c9c0ec417b65947c8422fcfa76150f073487d2b2e6745f761bb5a1e3d8fac742355f17ded151587038adf6f98c1f6a81e1775d7bbc1e29eb
+  metadata.gz: 99efe530bfcc0d0975f15f16951743f1196f1ce75cbfef8d16953dca89c122e737a2e32b30d811cd6abc0cfc09e433fe912c34ea87df048fcfabb0835ac51094
+  data.tar.gz: da1cd68b41023232ca064e7f16ee33737af88a995118aa42e09cfcc5bd4b21387e373dddc663364c467f282554319c255b803fe61fae6c571e487700a79cd1c2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-gkebackup_v1
 
+### v0.31.0 (2024-03-31)
+
+* Regenerated from discovery document revision 20240320
+
 ### v0.30.0 (2024-03-24)
 
 * Regenerated from discovery document revision 20240313

data/lib/google/apis/gkebackup_v1/classes.rb

@@ -432,6 +432,18 @@ module Google
         # @return [Google::Apis::GkebackupV1::RetentionPolicy]
         attr_accessor :retention_policy
       
+        # Output only. A number that represents the current risk level of this
+        # BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.
+        # Corresponds to the JSON property `rpoRiskLevel`
+        # @return [Fixnum]
+        attr_accessor :rpo_risk_level
+      
+        # Output only. Human-readable description of why the BackupPlan is in the
+        # current rpo_risk_level and action items if any.
+        # Corresponds to the JSON property `rpoRiskReason`
+        # @return [String]
+        attr_accessor :rpo_risk_reason
+      
         # Output only. State of the BackupPlan. This State field reflects the various
         # stages a BackupPlan can be in during the Create operation. It will be set to "
         # DEACTIVATED" if the BackupPlan is deactivated on an Update
@@ -473,6 +485,8 @@ module Google
           @name = args[:name] if args.key?(:name)
           @protected_pod_count = args[:protected_pod_count] if args.key?(:protected_pod_count)
           @retention_policy = args[:retention_policy] if args.key?(:retention_policy)
+          @rpo_risk_level = args[:rpo_risk_level] if args.key?(:rpo_risk_level)
+          @rpo_risk_reason = args[:rpo_risk_reason] if args.key?(:rpo_risk_reason)
           @state = args[:state] if args.key?(:state)
           @state_reason = args[:state_reason] if args.key?(:state_reason)
           @uid = args[:uid] if args.key?(:uid)
@@ -681,6 +695,66 @@ module Google
         end
       end
       
+      # Represents a whole or partial calendar date, such as a birthday. The time of
+      # day and time zone are either specified elsewhere or are insignificant. The
+      # date is relative to the Gregorian Calendar. This can represent one of the
+      # following: * A full date, with non-zero year, month, and day values. * A month
+      # and day, with a zero year (for example, an anniversary). * A year on its own,
+      # with a zero month and a zero day. * A year and month, with a zero day (for
+      # example, a credit card expiration date). Related types: * google.type.
+      # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
+      class Date
+        include Google::Apis::Core::Hashable
+      
+        # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
+        # specify a year by itself or a year and month where the day isn't significant.
+        # Corresponds to the JSON property `day`
+        # @return [Fixnum]
+        attr_accessor :day
+      
+        # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
+        # and day.
+        # Corresponds to the JSON property `month`
+        # @return [Fixnum]
+        attr_accessor :month
+      
+        # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
+        # year.
+        # Corresponds to the JSON property `year`
+        # @return [Fixnum]
+        attr_accessor :year
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @day = args[:day] if args.key?(:day)
+          @month = args[:month] if args.key?(:month)
+          @year = args[:year] if args.key?(:year)
+        end
+      end
+      
+      # Holds repeated DaysOfWeek values as a container.
+      class DayOfWeekList
+        include Google::Apis::Core::Hashable
+      
+        # Optional. A list of days of week.
+        # Corresponds to the JSON property `daysOfWeek`
+        # @return [Array<String>]
+        attr_accessor :days_of_week
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @days_of_week = args[:days_of_week] if args.key?(:days_of_week)
+        end
+      end
+      
       # A generic empty message that you can re-use to avoid defining duplicated empty
       # messages in your APIs. A typical example is to use it as the request or the
       # response type of an API method. For instance: service Foo ` rpc Bar(google.
@@ -718,6 +792,66 @@ module Google
         end
       end
       
+      # Defines a time window during which no backup should happen. All time and date
+      # are in UTC.
+      class ExclusionWindow
+        include Google::Apis::Core::Hashable
+      
+        # The exclusion window occurs every day if set to "True". Specifying this field
+        # to "False" is an error.
+        # Corresponds to the JSON property `daily`
+        # @return [Boolean]
+        attr_accessor :daily
+        alias_method :daily?, :daily
+      
+        # Holds repeated DaysOfWeek values as a container.
+        # Corresponds to the JSON property `daysOfWeek`
+        # @return [Google::Apis::GkebackupV1::DayOfWeekList]
+        attr_accessor :days_of_week
+      
+        # Required. Specifies duration of the window. Restrictions for duration based on
+        # the recurrence type to allow some time for backup to happen: -
+        # single_occurrence_date: no restriction, but UI may warn about this when
+        # duration >= target RPO - daily window: duration < 24 hours - weekly window: -
+        # days of week includes all seven days of a week: duration < 24 hours - all
+        # other weekly window: duration < 168 hours (i.e., 24 * 7 hours)
+        # Corresponds to the JSON property `duration`
+        # @return [String]
+        attr_accessor :duration
+      
+        # Represents a whole or partial calendar date, such as a birthday. The time of
+        # day and time zone are either specified elsewhere or are insignificant. The
+        # date is relative to the Gregorian Calendar. This can represent one of the
+        # following: * A full date, with non-zero year, month, and day values. * A month
+        # and day, with a zero year (for example, an anniversary). * A year on its own,
+        # with a zero month and a zero day. * A year and month, with a zero day (for
+        # example, a credit card expiration date). Related types: * google.type.
+        # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
+        # Corresponds to the JSON property `singleOccurrenceDate`
+        # @return [Google::Apis::GkebackupV1::Date]
+        attr_accessor :single_occurrence_date
+      
+        # Represents a time of day. The date and time zone are either not significant or
+        # are specified elsewhere. An API may choose to allow leap seconds. Related
+        # types are google.type.Date and `google.protobuf.Timestamp`.
+        # Corresponds to the JSON property `startTime`
+        # @return [Google::Apis::GkebackupV1::TimeOfDay]
+        attr_accessor :start_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @daily = args[:daily] if args.key?(:daily)
+          @days_of_week = args[:days_of_week] if args.key?(:days_of_week)
+          @duration = args[:duration] if args.key?(:duration)
+          @single_occurrence_date = args[:single_occurrence_date] if args.key?(:single_occurrence_date)
+          @start_time = args[:start_time] if args.key?(:start_time)
+        end
+      end
+      
       # Represents a textual expression in the Common Expression Language (CEL) syntax.
       # CEL is a C-like expression language. The syntax and semantics of CEL are
       # documented at https://github.com/google/cel-spec. Example (Comparison): title:
@@ -772,6 +906,25 @@ module Google
         end
       end
       
+      # Response message for GetBackupIndexDownloadUrl.
+      class GetBackupIndexDownloadUrlResponse
+        include Google::Apis::Core::Hashable
+      
+        # 
+        # Corresponds to the JSON property `signedUrl`
+        # @return [String]
+        attr_accessor :signed_url
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @signed_url = args[:signed_url] if args.key?(:signed_url)
+        end
+      end
+      
       # The request message for Operations.CancelOperation.
       class GoogleLongrunningCancelOperationRequest
         include Google::Apis::Core::Hashable
@@ -1840,6 +1993,41 @@ module Google
         end
       end
       
+      # Defines RPO scheduling configuration for automatically creating Backups via
+      # this BackupPlan.
+      class RpoConfig
+        include Google::Apis::Core::Hashable
+      
+        # Optional. User specified time windows during which backup can NOT happen for
+        # this BackupPlan - backups should start and finish outside of any given
+        # exclusion window. Note: backup jobs will be scheduled to start and finish
+        # outside the duration of the window as much as possible, but running jobs will
+        # not get canceled when it runs into the window. All the time and date values in
+        # exclusion_windows entry in the API are in UTC. We only allow <=1 recurrence (
+        # daily or weekly) exclusion window for a BackupPlan while no restriction on
+        # number of single occurrence windows.
+        # Corresponds to the JSON property `exclusionWindows`
+        # @return [Array<Google::Apis::GkebackupV1::ExclusionWindow>]
+        attr_accessor :exclusion_windows
+      
+        # Required. Defines the target RPO for the BackupPlan in minutes, which means
+        # the target maximum data loss in time that is acceptable for this BackupPlan.
+        # This must be at least 60, i.e., 1 hour, and at most 86400, i.e., 60 days.
+        # Corresponds to the JSON property `targetRpoMinutes`
+        # @return [Fixnum]
+        attr_accessor :target_rpo_minutes
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @exclusion_windows = args[:exclusion_windows] if args.key?(:exclusion_windows)
+          @target_rpo_minutes = args[:target_rpo_minutes] if args.key?(:target_rpo_minutes)
+        end
+      end
+      
       # Defines scheduling parameters for automatically creating Backups via this
       # BackupPlan.
       class Schedule
@@ -1854,6 +2042,12 @@ module Google
         # @return [String]
         attr_accessor :cron_schedule
       
+        # Output only. Start time of next scheduled backup under this BackupPlan by
+        # either cron_schedule or rpo config.
+        # Corresponds to the JSON property `nextScheduledBackupTime`
+        # @return [String]
+        attr_accessor :next_scheduled_backup_time
+      
         # Optional. This flag denotes whether automatic Backup creation is paused for
         # this BackupPlan. Default: False
         # Corresponds to the JSON property `paused`
@@ -1861,6 +2055,12 @@ module Google
         attr_accessor :paused
         alias_method :paused?, :paused
       
+        # Defines RPO scheduling configuration for automatically creating Backups via
+        # this BackupPlan.
+        # Corresponds to the JSON property `rpoConfig`
+        # @return [Google::Apis::GkebackupV1::RpoConfig]
+        attr_accessor :rpo_config
+      
         def initialize(**args)
            update!(**args)
         end
@@ -1868,7 +2068,9 @@ module Google
         # Update properties of this object
         def update!(**args)
           @cron_schedule = args[:cron_schedule] if args.key?(:cron_schedule)
+          @next_scheduled_backup_time = args[:next_scheduled_backup_time] if args.key?(:next_scheduled_backup_time)
           @paused = args[:paused] if args.key?(:paused)
+          @rpo_config = args[:rpo_config] if args.key?(:rpo_config)
         end
       end
       
@@ -2032,6 +2234,47 @@ module Google
         end
       end
       
+      # Represents a time of day. The date and time zone are either not significant or
+      # are specified elsewhere. An API may choose to allow leap seconds. Related
+      # types are google.type.Date and `google.protobuf.Timestamp`.
+      class TimeOfDay
+        include Google::Apis::Core::Hashable
+      
+        # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to
+        # allow the value "24:00:00" for scenarios like business closing time.
+        # Corresponds to the JSON property `hours`
+        # @return [Fixnum]
+        attr_accessor :hours
+      
+        # Minutes of hour of day. Must be from 0 to 59.
+        # Corresponds to the JSON property `minutes`
+        # @return [Fixnum]
+        attr_accessor :minutes
+      
+        # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+        # Corresponds to the JSON property `nanos`
+        # @return [Fixnum]
+        attr_accessor :nanos
+      
+        # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
+        # allow the value 60 if it allows leap-seconds.
+        # Corresponds to the JSON property `seconds`
+        # @return [Fixnum]
+        attr_accessor :seconds
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @hours = args[:hours] if args.key?(:hours)
+          @minutes = args[:minutes] if args.key?(:minutes)
+          @nanos = args[:nanos] if args.key?(:nanos)
+          @seconds = args[:seconds] if args.key?(:seconds)
+        end
+      end
+      
       # A transformation rule to be applied against Kubernetes resources as they are
       # selected for restoration from a Backup. A rule contains both filtering logic (
       # which resources are subject to transform) and transformation logic.

data/lib/google/apis/gkebackup_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module GkebackupV1
       # Version of the google-apis-gkebackup_v1 gem
-      GEM_VERSION = "0.30.0"
+      GEM_VERSION = "0.31.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.14.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240313"
+      REVISION = "20240320"
     end
   end
 end

data/lib/google/apis/gkebackup_v1/representations.rb

@@ -70,6 +70,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Date
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class DayOfWeekList
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Empty
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -82,12 +94,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ExclusionWindow
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Expr
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GetBackupIndexDownloadUrlResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleLongrunningCancelOperationRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -226,6 +250,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class RpoConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Schedule
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -256,6 +286,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class TimeOfDay
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class TransformationRule
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -366,6 +402,8 @@ module Google
           property :protected_pod_count, as: 'protectedPodCount'
           property :retention_policy, as: 'retentionPolicy', class: Google::Apis::GkebackupV1::RetentionPolicy, decorator: Google::Apis::GkebackupV1::RetentionPolicy::Representation
       
+          property :rpo_risk_level, as: 'rpoRiskLevel'
+          property :rpo_risk_reason, as: 'rpoRiskReason'
           property :state, as: 'state'
           property :state_reason, as: 'stateReason'
           property :uid, as: 'uid'
@@ -406,6 +444,22 @@ module Google
         end
       end
       
+      class Date
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :day, as: 'day'
+          property :month, as: 'month'
+          property :year, as: 'year'
+        end
+      end
+      
+      class DayOfWeekList
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :days_of_week, as: 'daysOfWeek'
+        end
+      end
+      
       class Empty
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -419,6 +473,20 @@ module Google
         end
       end
       
+      class ExclusionWindow
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :daily, as: 'daily'
+          property :days_of_week, as: 'daysOfWeek', class: Google::Apis::GkebackupV1::DayOfWeekList, decorator: Google::Apis::GkebackupV1::DayOfWeekList::Representation
+      
+          property :duration, as: 'duration'
+          property :single_occurrence_date, as: 'singleOccurrenceDate', class: Google::Apis::GkebackupV1::Date, decorator: Google::Apis::GkebackupV1::Date::Representation
+      
+          property :start_time, as: 'startTime', class: Google::Apis::GkebackupV1::TimeOfDay, decorator: Google::Apis::GkebackupV1::TimeOfDay::Representation
+      
+        end
+      end
+      
       class Expr
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -429,6 +497,13 @@ module Google
         end
       end
       
+      class GetBackupIndexDownloadUrlResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :signed_url, as: 'signedUrl'
+        end
+      end
+      
       class GoogleLongrunningCancelOperationRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -683,11 +758,23 @@ module Google
         end
       end
       
+      class RpoConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :exclusion_windows, as: 'exclusionWindows', class: Google::Apis::GkebackupV1::ExclusionWindow, decorator: Google::Apis::GkebackupV1::ExclusionWindow::Representation
+      
+          property :target_rpo_minutes, as: 'targetRpoMinutes'
+        end
+      end
+      
       class Schedule
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :cron_schedule, as: 'cronSchedule'
+          property :next_scheduled_backup_time, as: 'nextScheduledBackupTime'
           property :paused, as: 'paused'
+          property :rpo_config, as: 'rpoConfig', class: Google::Apis::GkebackupV1::RpoConfig, decorator: Google::Apis::GkebackupV1::RpoConfig::Representation
+      
         end
       end
       
@@ -726,6 +813,16 @@ module Google
         end
       end
       
+      class TimeOfDay
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :hours, as: 'hours'
+          property :minutes, as: 'minutes'
+          property :nanos, as: 'nanos'
+          property :seconds, as: 'seconds'
+        end
+      end
+      
       class TransformationRule
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/gkebackup_v1/service.rb

@@ -559,6 +559,37 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Retrieve the link to the backupIndex.
+        # @param [String] backup
+        #   Required. Full name of Backup resource. Format: projects/`project`/locations/`
+        #   location`/backupPlans/`backup_plan`/backups/`backup`
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::GkebackupV1::GetBackupIndexDownloadUrlResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::GkebackupV1::GetBackupIndexDownloadUrlResponse]
+        #
+        # @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_backup_plan_backup_backup_index_download_url(backup, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+backup}:getBackupIndexDownloadUrl', options)
+          command.response_representation = Google::Apis::GkebackupV1::GetBackupIndexDownloadUrlResponse::Representation
+          command.response_class = Google::Apis::GkebackupV1::GetBackupIndexDownloadUrlResponse
+          command.params['backup'] = backup unless backup.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the access control policy for a resource. Returns an empty policy if the
         # resource exists and does not have a policy set.
         # @param [String] resource

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-gkebackup_v1
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-24 00:00:00.000000000 Z
+date: 2024-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-gkebackup_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-gkebackup_v1/v0.30.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-gkebackup_v1/v0.31.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-gkebackup_v1
 post_install_message: 
 rdoc_options: []