google-cloud-os_config-v1 0.1.0

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Cloud OS Config V1 Protocol Buffer Documentation
+
+These files are for the YARD documentation of the generated protobuf files.
+They are not intended to be required or loaded at runtime.

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 Api
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+    end
+  end
+end

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 Api
+    # A simple descriptor of a resource type.
+    #
+    # ResourceDescriptor annotates a resource message (either by means of a
+    # protobuf annotation or use in the service config), and associates the
+    # resource's schema, the resource type, and the pattern of the resource name.
+    #
+    # Example:
+    #
+    #     message Topic {
+    #       // Indicates this message defines a resource schema.
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // For Kubernetes resources, the format is {api group}/{kind}.
+    #       option (google.api.resource) = {
+    #         type: "pubsub.googleapis.com/Topic"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #    resources:
+    #    - type: "pubsub.googleapis.com/Topic"
+    #      name_descriptor:
+    #        - pattern: "projects/\\{project}/topics/\\{topic}"
+    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #          parent_name_extractor: "projects/\\{project}"
+    #
+    # Sometimes, resources have multiple patterns, typically because they can
+    # live under multiple parents.
+    #
+    # Example:
+    #
+    #     message LogEntry {
+    #       option (google.api.resource) = {
+    #         type: "logging.googleapis.com/LogEntry"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         - pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         - pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #
+    # For flexible resources, the resource name doesn't contain parent names, but
+    # the resource itself has parents for policy evaluation.
+    #
+    # Example:
+    #
+    #     message Shelf {
+    #       option (google.api.resource) = {
+    #         type: "library.googleapis.com/Shelf"
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'library.googleapis.com/Shelf'
+    #       name_descriptor:
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type. It must be in the format of
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
+    #     singular and must not include version numbers.
+    #
+    #     Example: `storage.googleapis.com/Bucket`
+    #
+    #     The value of the resource_type_kind must follow the regular expression
+    #     /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
+    #     should use PascalCase (UpperCamelCase). The maximum number of
+    #     characters allowed for the `resource_type_kind` is 100.
+    # @!attribute [rw] pattern
+    #   @return [::Array<::String>]
+    #     Optional. The relative resource name pattern associated with this resource
+    #     type. The DNS prefix of the full resource name shouldn't be specified here.
+    #
+    #     The path pattern must follow the syntax, which aligns with HTTP binding
+    #     syntax:
+    #
+    #         Template = Segment { "/" Segment } ;
+    #         Segment = LITERAL | Variable ;
+    #         Variable = "{" LITERAL "}" ;
+    #
+    #     Examples:
+    #
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
+    #
+    #     The components in braces correspond to the IDs for each resource in the
+    #     hierarchy. It is expected that, if multiple patterns are provided,
+    #     the same component name (e.g. "project") refers to IDs of the same
+    #     type of resource.
+    # @!attribute [rw] name_field
+    #   @return [::String]
+    #     Optional. The field on the resource that designates the resource name
+    #     field. If omitted, this is assumed to be "name".
+    # @!attribute [rw] history
+    #   @return [::Google::Api::ResourceDescriptor::History]
+    #     Optional. The historical or future-looking state of the resource pattern.
+    #
+    #     Example:
+    #
+    #         // The InspectTemplate message originally only supported resource
+    #         // names with organization, and project was added later.
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
+    #             type: "dlp.googleapis.com/InspectTemplate"
+    #             pattern:
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
+    #             history: ORIGINALLY_SINGLE_PATTERN
+    #           };
+    #         }
+    # @!attribute [rw] plural
+    #   @return [::String]
+    #     The plural name used in the resource name, such as 'projects' for
+    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
+    #     field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    # @!attribute [rw] singular
+    #   @return [::String]
+    #     The same concept of the `singular` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    class ResourceDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # A description of the historical or future-looking state of the
+      # resource pattern.
+      module History
+        # The "unset" value.
+        HISTORY_UNSPECIFIED = 0
+
+        # The resource originally had one pattern and launched as such, and
+        # additional patterns were added later.
+        ORIGINALLY_SINGLE_PATTERN = 1
+
+        # The resource has one pattern, but the API owner expects to add more
+        # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
+        # that from being necessary once there are multiple patterns.)
+        FUTURE_MULTI_PATTERN = 2
+      end
+    end
+
+    # Defines a proto annotation that describes a string field that refers to
+    # an API resource.
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type that the annotated field references.
+    #
+    #     Example:
+    #
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
+    #             type: "pubsub.googleapis.com/Topic"
+    #           }];
+    #         }
+    # @!attribute [rw] child_type
+    #   @return [::String]
+    #     The resource type of a child collection that the annotated field
+    #     references. This is useful for annotating the `parent` field that
+    #     doesn't have a fixed resource type.
+    #
+    #     Example:
+    #
+    #       message ListLogEntriesRequest {
+    #         string parent = 1 [(google.api.resource_reference) = {
+    #           child_type: "logging.googleapis.com/LogEntry"
+    #         };
+    #       }
+    class ResourceReference
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/cloud/osconfig/v1/patch_deployments.rb

@@ -0,0 +1,242 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 Cloud
+    module OsConfig
+      module V1
+        # Patch deployments are configurations that individual patch jobs use to
+        # complete a patch. These configurations include instance filter, package
+        # repository settings, and a schedule. For more information about creating and
+        # managing patch deployments, see [Scheduling patch
+        # jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Unique name for the patch deployment resource in a project. The patch
+        #     deployment name is in the form:
+        #     `projects/{project_id}/patchDeployments/{patch_deployment_id}`.
+        #     This field is ignored when you create a new patch deployment.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. Description of the patch deployment. Length of the description is limited
+        #     to 1024 characters.
+        # @!attribute [rw] instance_filter
+        #   @return [::Google::Cloud::OsConfig::V1::PatchInstanceFilter]
+        #     Required. VM instances to patch.
+        # @!attribute [rw] patch_config
+        #   @return [::Google::Cloud::OsConfig::V1::PatchConfig]
+        #     Optional. Patch configuration that is applied.
+        # @!attribute [rw] duration
+        #   @return [::Google::Protobuf::Duration]
+        #     Optional. Duration of the patch. After the duration ends, the patch times out.
+        # @!attribute [rw] one_time_schedule
+        #   @return [::Google::Cloud::OsConfig::V1::OneTimeSchedule]
+        #     Required. Schedule a one-time execution.
+        # @!attribute [rw] recurring_schedule
+        #   @return [::Google::Cloud::OsConfig::V1::RecurringSchedule]
+        #     Required. Schedule recurring executions.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Time the patch deployment was created. Timestamp is in
+        #     [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Time the patch deployment was last updated. Timestamp is in
+        #     [RFC3339]("https://www.ietf.org/rfc/rfc3339.txt) text format.
+        # @!attribute [r] last_execute_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The last time a patch job was started by this deployment.
+        #     Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text
+        #     format.
+        class PatchDeployment
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Sets the time for a one time patch deployment. Timestamp is in
+        # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+        # @!attribute [rw] execute_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Required. The desired patch job execution time.
+        class OneTimeSchedule
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Sets the time for recurring patch deployments.
+        # @!attribute [rw] time_zone
+        #   @return [::Google::Type::TimeZone]
+        #     Required. Defines the time zone that `time_of_day` is relative to.
+        #     The rules for daylight saving time are determined by the chosen time zone.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Optional. The time that the recurring schedule becomes effective.
+        #     Defaults to `create_time` of the patch deployment.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Optional. The end time at which a recurring patch deployment schedule is no longer
+        #     active.
+        # @!attribute [rw] time_of_day
+        #   @return [::Google::Type::TimeOfDay]
+        #     Required. Time of the day to run a recurring deployment.
+        # @!attribute [rw] frequency
+        #   @return [::Google::Cloud::OsConfig::V1::RecurringSchedule::Frequency]
+        #     Required. The frequency unit of this recurring schedule.
+        # @!attribute [rw] weekly
+        #   @return [::Google::Cloud::OsConfig::V1::WeeklySchedule]
+        #     Required. Schedule with weekly executions.
+        # @!attribute [rw] monthly
+        #   @return [::Google::Cloud::OsConfig::V1::MonthlySchedule]
+        #     Required. Schedule with monthly executions.
+        # @!attribute [r] last_execute_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the last patch job ran successfully.
+        # @!attribute [r] next_execute_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the next patch job is scheduled to run.
+        class RecurringSchedule
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Specifies the frequency of the recurring patch deployments.
+          module Frequency
+            # Invalid. A frequency must be specified.
+            FREQUENCY_UNSPECIFIED = 0
+
+            # Indicates that the frequency should be expressed in terms of
+            # weeks.
+            WEEKLY = 1
+
+            # Indicates that the frequency should be expressed in terms of
+            # months.
+            MONTHLY = 2
+          end
+        end
+
+        # Represents a weekly schedule.
+        # @!attribute [rw] day_of_week
+        #   @return [::Google::Type::DayOfWeek]
+        #     Required. Day of the week.
+        class WeeklySchedule
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents a monthly schedule. An example of a valid monthly schedule is
+        # "on the third Tuesday of the month" or "on the 15th of the month".
+        # @!attribute [rw] week_day_of_month
+        #   @return [::Google::Cloud::OsConfig::V1::WeekDayOfMonth]
+        #     Required. Week day in a month.
+        # @!attribute [rw] month_day
+        #   @return [::Integer]
+        #     Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1
+        #     indicates the last day of the month.
+        #     Months without the target day will be skipped. For example, a schedule to
+        #     run "every month on the 31st" will not run in February, April, June, etc.
+        class MonthlySchedule
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents one week day in a month. An example is "the 4th Sunday".
+        # @!attribute [rw] week_ordinal
+        #   @return [::Integer]
+        #     Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1
+        #     indicates the last week of the month.
+        # @!attribute [rw] day_of_week
+        #   @return [::Google::Type::DayOfWeek]
+        #     Required. A day of the week.
+        class WeekDayOfMonth
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message for creating a patch deployment.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The project to apply this patch deployment to in the form `projects/*`.
+        # @!attribute [rw] patch_deployment_id
+        #   @return [::String]
+        #     Required. A name for the patch deployment in the project. When creating a name
+        #     the following rules apply:
+        #     * Must contain only lowercase letters, numbers, and hyphens.
+        #     * Must start with a letter.
+        #     * Must be between 1-63 characters.
+        #     * Must end with a number or a letter.
+        #     * Must be unique within the project.
+        # @!attribute [rw] patch_deployment
+        #   @return [::Google::Cloud::OsConfig::V1::PatchDeployment]
+        #     Required. The patch deployment to create.
+        class CreatePatchDeploymentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message for retrieving a patch deployment.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the patch deployment in the form
+        #     `projects/*/patchDeployments/*`.
+        class GetPatchDeploymentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message for listing patch deployments.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the parent in the form `projects/*`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of patch deployments to return. Default is 100.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A pagination token returned from a previous call to ListPatchDeployments
+        #     that indicates where this listing should continue from.
+        class ListPatchDeploymentsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A response message for listing patch deployments.
+        # @!attribute [rw] patch_deployments
+        #   @return [::Array<::Google::Cloud::OsConfig::V1::PatchDeployment>]
+        #     The list of patch deployments.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A pagination token that can be used to get the next page of patch
+        #     deployments.
+        class ListPatchDeploymentsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message for deleting a patch deployment.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the patch deployment in the form
+        #     `projects/*/patchDeployments/*`.
+        class DeletePatchDeploymentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end