google-cloud-audit_manager-v1 1.1.1 → 1.2.0

data/proto_docs/google/cloud/auditmanager/v1/auditmanager.rb

@@ -41,6 +41,20 @@ module Google
         #     at the project level using the service agent at the organization or folder
         #     level, all the buckets that are associated with the service agent are
         #     available.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     Optional. If `true`, only validates the request and does not enroll the
+        #     resource. This executes standard request validation (such as schema, IAM,
+        #     and destination checks) and skips the apply phase.
+        #
+        #     Use this field for the following purposes:
+        #     * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run
+        #       dry-run mutations (e.g., `terraform plan`) without creating real
+        #       resources or incurring costs.
+        #     * **User Interface Validation**: Enable real-time form and permission
+        #       validation in custom UIs before submitting requests.
+        #     * **CI/CD & Automation**: Test your scripts, permissions, and parameters
+        #       safely without consuming resource quotas.
         class EnrollResourceRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -82,6 +96,21 @@ module Google
         #   @return [::String]
         #     Required. Framework (set of controls) that the audit scope report is
         #     generated against. For example, `NIST_800_53`.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     Optional. If `true`, only validates the request and does not generate the
+        #     audit scope report. This executes standard request validation (such as
+        #     schema, framework existence, scope, and IAM checks) and skips the apply
+        #     phase.
+        #
+        #     Use this field for the following purposes:
+        #     * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run
+        #       dry-run mutations (e.g., `terraform plan`) without creating real
+        #       resources or incurring costs.
+        #     * **User Interface Validation**: Enable real-time form and permission
+        #       validation in custom UIs before submitting requests.
+        #     * **CI/CD & Automation**: Test your scripts, permissions, and parameters
+        #       safely without consuming resource quotas.
         class GenerateAuditScopeReportRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -684,6 +713,235 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for
+        # {::Google::Cloud::AuditManager::V1::AuditManager::Client#create_audit_schedule CreateAuditSchedule}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Project or folder that this audit schedule is for, in one of the
+        #     following formats:
+        #
+        #     * `projects/{project}/locations/{location}`
+        #     * `folders/{folder}/locations/{location}`
+        # @!attribute [rw] audit_schedule
+        #   @return [::Google::Cloud::AuditManager::V1::AuditSchedule]
+        #     Required. Audit schedule to create.
+        # @!attribute [rw] audit_schedule_id
+        #   @return [::String]
+        #     Required. ID to use for the audit schedule, which becomes the final
+        #     component of the audit schedule's resource name.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     Optional. If `true`, only validates the request and does not create the
+        #     audit schedule. This executes standard request validation (such as schema,
+        #     framework existence, scope, and IAM checks) and skips the apply phase.
+        #
+        #     Use this field for the following purposes:
+        #     * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run
+        #       dry-run mutations (e.g., `terraform plan`) without creating real
+        #       resources or incurring costs.
+        #     * **User Interface Validation**: Enable real-time form and permission
+        #       validation in custom UIs before submitting requests.
+        #     * **CI/CD & Automation**: Test your scripts, permissions, and parameters
+        #       safely without consuming resource quotas.
+        class CreateAuditScheduleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AuditManager::V1::AuditManager::Client#update_audit_schedule UpdateAuditSchedule}.
+        # @!attribute [rw] audit_schedule
+        #   @return [::Google::Cloud::AuditManager::V1::AuditSchedule]
+        #     Required. Audit schedule to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. List of fields to update.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     Optional. If `true`, only validates the request and does not update the
+        #     audit schedule. This executes standard request validation (such as
+        #     schema, framework existence, scope, and IAM checks) and skips the apply
+        #     phase.
+        #
+        #     Use this field for the following purposes:
+        #     * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run
+        #       dry-run mutations (e.g., `terraform plan`) without creating real
+        #       resources or incurring costs.
+        #     * **User Interface Validation**: Enable real-time form and permission
+        #       validation in custom UIs before submitting requests.
+        #     * **CI/CD & Automation**: Test your scripts, permissions, and parameters
+        #       safely without consuming resource quotas.
+        class UpdateAuditScheduleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AuditManager::V1::AuditManager::Client#get_audit_schedule GetAuditSchedule}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the audit schedule to retrieve, in one of the following
+        #     formats:
+        #
+        #     * `projects/{project}/locations/{location}/auditSchedules/{audit_schedule}`
+        #     * `folders/{folder}/locations/{location}/auditSchedules/{audit_schedule}`
+        #     * `organizations/{organization}/locations/{location}/auditSchedules/{audit_schedule}`
+        class GetAuditScheduleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AuditManager::V1::AuditManager::Client#list_audit_schedules ListAuditSchedules}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Parent for the audit schedule, in one of the following formats:
+        #
+        #     * `projects/{project}/locations/{location}`
+        #     * `folders/{folder}/locations/{location}`
+        #     * `organizations/{organization}/locations/{location}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Maximum number of items to return in a single page. The service
+        #     might return fewer items than this value. If unspecified, the service picks
+        #     an appropriate default. The maximum value is 100; values above 100 are
+        #     reduced to 100.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous call, to retrieve the next
+        #     page of results.
+        class ListAuditSchedulesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::AuditManager::V1::AuditManager::Client#list_audit_schedules ListAuditSchedules}.
+        # @!attribute [rw] audit_schedules
+        #   @return [::Array<::Google::Cloud::AuditManager::V1::AuditSchedule>]
+        #     List of audit schedules.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that you can send as the `page_token` in a subsequent request to
+        #     retrieve the next page of results. If this field is empty, there are no
+        #     subsequent pages.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Locations that can't be reached.
+        class ListAuditSchedulesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An audit schedule, in one of the following formats:
+        #
+        # * `projects/{project}/locations/{location}/auditSchedules/{audit_schedule}`
+        # * `folders/{folder}/locations/{location}/auditSchedules/{audit_schedule}`
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. Unique identifier for the audit schedule.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/auditSchedules/\\{audit_schedule}
+        #     folders/\\{folder}/locations/\\{location}/auditSchedules/\\{audit_schedule}
+        #     organizations/\\{organization}/locations/\\{location}/auditSchedules/\\{audit_schedule}
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. Display name for the audit schedule.
+        # @!attribute [rw] gcs_uri
+        #   @return [::String]
+        #     Required. Cloud Storage bucket where Audit Manager can upload the audit
+        #     report and evidence. The format is `gs://{bucket_name}`.
+        # @!attribute [rw] compliance_framework
+        #   @return [::String]
+        #     Required. Framework (set of controls) that the audit scope report is
+        #     generated against. For example, `NIST_800_53`.
+        # @!attribute [rw] report_format
+        #   @return [::Google::Cloud::AuditManager::V1::AuditSchedule::AuditReportFormat]
+        #     Required. Format for the audit report.
+        # @!attribute [rw] schedule_config
+        #   @return [::Google::Cloud::AuditManager::V1::ScheduleConfig]
+        #     Required. Configuration that defines when and how often audit runs are
+        #     automatically triggered for this schedule.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::AuditManager::V1::ScheduleState]
+        #     Optional. State of the audit schedule. While most states are managed by the
+        #     system, you can use
+        #     {::Google::Cloud::AuditManager::V1::AuditManager::Client#update_audit_schedule UpdateAuditSchedule}
+        #     to start, pause, or delete the schedule.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the schedule was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the schedule was last updated.
+        # @!attribute [r] next_run_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Calculated timestamp for the next scheduled run.
+        # @!attribute [r] last_trigger_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the audit run was last triggered.
+        # @!attribute [r] error_message
+        #   @return [::String]
+        #     Output only. Describes the error if the schedule is in an error state.
+        class AuditSchedule
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Format for the audit report.
+          module AuditReportFormat
+            # Default value. This value is unused.
+            AUDIT_REPORT_FORMAT_UNSPECIFIED = 0
+
+            # Open Document Format (ODF).
+            AUDIT_REPORT_FORMAT_ODF = 1
+          end
+        end
+
+        # Timing and frequency parameters for recurring audit runs.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Required. Date and time when the first audit run is triggered.
+        #     Subsequent runs are based on this time and the chosen frequency.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Optional. Date that the schedule stops.
+        #     If not specified, the schedule runs indefinitely.
+        # @!attribute [rw] frequency
+        #   @return [::Google::Cloud::AuditManager::V1::ScheduleConfig::Frequency]
+        #     Required. Frequency of audit runs.
+        # @!attribute [rw] time_zone
+        #   @return [::String]
+        #     Optional. Time zone for the audit schedule in IANA format (for example,
+        #     `America/New_York`). The time zone is used to interpret the `start_time`
+        #     and the `end_time`, and to calculate subsequent run dates.
+        #     If not specified, the time zone default is UTC.
+        class ScheduleConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Frequency of audit runs.
+          module Frequency
+            # Default value. This value is unused.
+            FREQUENCY_UNSPECIFIED = 0
+
+            # The audit runs every day.
+            DAILY = 1
+
+            # The audit runs weekly on the same day of the week as `start_time`.
+            WEEKLY = 2
+
+            # The audit runs monthly on the same day of the month as `start_time`.
+            MONTHLY = 3
+
+            # The audit runs quarterly (every 3 months) on the same
+            # day of the month as `start_time`.
+            QUARTERLY = 4
+
+            # The audit runs annually on the same month and day as `start_time`.
+            ANNUALLY = 5
+          end
+        end
+
         # Different execution states of the Audit Manager service.
         module OperationState
           # Default value. This value is unused.
@@ -735,6 +993,31 @@ module Google
           # The resource can't be audited.
           AUDIT_NOT_SUPPORTED = 5
         end
+
+        # State of an audit schedule.
+        module ScheduleState
+          # Default value. This value is unused.
+          SCHEDULE_STATE_UNSPECIFIED = 0
+
+          # Schedule is active and will trigger runs.
+          SCHEDULE_STATE_ACTIVE = 1
+
+          # Schedule is paused and will not trigger runs.
+          SCHEDULE_STATE_PAUSED = 2
+
+          # Schedule end time has passed.
+          SCHEDULE_STATE_COMPLETED = 3
+
+          # Schedule setup failed during creation or update.
+          SCHEDULE_STATE_FAILED_SETUP = 4
+
+          # Schedule is in an error state due to persistent failure to trigger an
+          # audit. Manual intervention is required.
+          SCHEDULE_STATE_ERROR = 5
+
+          # Schedule has been marked for deletion by the user.
+          SCHEDULE_STATE_DELETED = 6
+        end
       end
     end
   end

data/proto_docs/google/protobuf/field_mask.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # `FieldMask` represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # # Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # # Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
+    #
+    # For example, given the target message:
+    #
+    #     f {
+    #       b {
+    #         d: 1
+    #         x: 2
+    #       }
+    #       c: [1]
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #       }
+    #       c: [2]
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: ["f.b", "f.c"]
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #         x: 2
+    #       }
+    #       c: [1, 2]
+    #     }
+    #
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # ## Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # # JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for `Profile` may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # # Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    #
+    # ## Field Mask Verification
+    #
+    # The implementation of any API method which has a FieldMask type field in the
+    # request should verify the included field paths, and return an
+    # `INVALID_ARGUMENT` error if any path is unmappable.
+    # @!attribute [rw] paths
+    #   @return [::Array<::String>]
+    #     The set of field mask paths.
+    class FieldMask
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-audit_manager-v1
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Google LLC
@@ -90,6 +90,7 @@ files:
 - proto_docs/google/protobuf/any.rb
 - proto_docs/google/protobuf/duration.rb
 - proto_docs/google/protobuf/empty.rb
+- proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/timestamp.rb
 - proto_docs/google/rpc/status.rb
 homepage: https://github.com/googleapis/google-cloud-ruby