google-cloud-assured_workloads-v1beta1 0.1.0

data/proto_docs/google/cloud/assuredworkloads/v1beta1/assuredworkloads_v1beta1.rb

@@ -0,0 +1,307 @@
+# 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 AssuredWorkloads
+      module V1beta1
+        # Request for creating a workload.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the new Workload's parent.
+        #     Must be of the form `organizations/{org_id}/locations/{location_id}`.
+        # @!attribute [rw] workload
+        #   @return [::Google::Cloud::AssuredWorkloads::V1beta1::Workload]
+        #     Required. Assured Workload to create
+        # @!attribute [rw] external_id
+        #   @return [::String]
+        #     Optional. A identifier associated with the workload and underlying projects which
+        #     allows for the break down of billing costs for a workload. The value
+        #     provided for the identifier will add a label to the workload and contained
+        #     projects with the identifier as the value.
+        class CreateWorkloadRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for Updating a workload.
+        # @!attribute [rw] workload
+        #   @return [::Google::Cloud::AssuredWorkloads::V1beta1::Workload]
+        #     Required. The workload to update.
+        #     The workload’s `name` field is used to identify the workload to be updated.
+        #     Format:
+        #     organizations/\\{org_id}/locations/\\{location_id}/workloads/\\{workload_id}
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. The list of fields to be updated.
+        class UpdateWorkloadRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for deleting a Workload.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The `name` field is used to identify the workload.
+        #     Format:
+        #     organizations/\\{org_id}/locations/\\{location_id}/workloads/\\{workload_id}
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     Optional. The etag of the workload.
+        #     If this is provided, it must match the server's etag.
+        class DeleteWorkloadRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for fetching a workload.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Workload to fetch. This is the workloads's
+        #     relative path in the API, formatted as
+        #     "organizations/\\{organization_id}/locations/\\{location_id}/workloads/\\{workload_id}".
+        #     For example,
+        #     "organizations/123/locations/us-east1/workloads/assured-workload-1".
+        class GetWorkloadRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for fetching workloads in an organization.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Parent Resource to list workloads from.
+        #     Must be of the form `organizations/{org_id}/locations/{location}`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Page size.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Page token returned from previous request. Page token contains context from
+        #     previous request. Page token needs to be passed in the second and following
+        #     requests.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     A custom filter for filtering by properties of a workload. At this time,
+        #     only filtering by labels is supported.
+        class ListWorkloadsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of ListWorkloads endpoint.
+        # @!attribute [rw] workloads
+        #   @return [::Array<::Google::Cloud::AssuredWorkloads::V1beta1::Workload>]
+        #     List of Workloads under a given parent.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     The next page token. Return empty if reached the last page.
+        class ListWorkloadsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An Workload object for managing highly regulated workloads of cloud
+        # customers.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Optional. The resource name of the workload.
+        #     Format:
+        #     organizations/\\{organization}/locations/\\{location}/workloads/\\{workload}
+        #
+        #     Read-only.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The user-assigned display name of the Workload.
+        #     When present it must be between 4 to 30 characters.
+        #     Allowed characters are: lowercase and uppercase letters, numbers,
+        #     hyphen, single-quote, double-quote, space, and exclamation point.
+        #
+        #     Example: My Workload
+        # @!attribute [r] resources
+        #   @return [::Array<::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ResourceInfo>]
+        #     Output only. The resources associated with this workload.
+        #     These resources will be created when creating the workload.
+        #     If any of the projects already exist, the workload creation will fail.
+        #     Always read only.
+        # @!attribute [rw] compliance_regime
+        #   @return [::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ComplianceRegime]
+        #     Required. Immutable. Compliance Regime associated with this workload.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Immutable. The Workload creation timestamp.
+        # @!attribute [rw] billing_account
+        #   @return [::String]
+        #     Required. Input only. The billing account used for the resources which are
+        #     direct children of workload. This billing account is initially associated
+        #     with the resources created as part of Workload creation.
+        #     After the initial creation of these resources, the customer can change
+        #     the assigned billing account.
+        #     The resource name has the form
+        #     `billingAccounts/{billing_account_id}`. For example,
+        #     `billingAccounts/012345-567890-ABCDEF`.
+        # @!attribute [rw] il4_settings
+        #   @return [::Google::Cloud::AssuredWorkloads::V1beta1::Workload::IL4Settings]
+        #     Required. Input only. Immutable. Settings specific to resources needed for IL4.
+        # @!attribute [rw] cjis_settings
+        #   @return [::Google::Cloud::AssuredWorkloads::V1beta1::Workload::CJISSettings]
+        #     Required. Input only. Immutable. Settings specific to resources needed for CJIS.
+        # @!attribute [rw] fedramp_high_settings
+        #   @return [::Google::Cloud::AssuredWorkloads::V1beta1::Workload::FedrampHighSettings]
+        #     Required. Input only. Immutable. Settings specific to resources needed for FedRAMP High.
+        # @!attribute [rw] fedramp_moderate_settings
+        #   @return [::Google::Cloud::AssuredWorkloads::V1beta1::Workload::FedrampModerateSettings]
+        #     Required. Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     Optional. ETag of the workload, it is calculated on the basis
+        #     of the Workload contents. It will be used in Update & Delete operations.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Labels applied to the workload.
+        class Workload
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represent the resources that are children of this Workload.
+          # @!attribute [rw] resource_id
+          #   @return [::Integer]
+          #     Resource identifier.
+          #     For a project this represents project_number.
+          # @!attribute [rw] resource_type
+          #   @return [::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ResourceInfo::ResourceType]
+          #     Indicates the type of resource.
+          class ResourceInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of resource.
+            module ResourceType
+              # Unknown resource type.
+              RESOURCE_TYPE_UNSPECIFIED = 0
+
+              # Consumer project.
+              CONSUMER_PROJECT = 1
+
+              # Consumer project containing encryption keys.
+              ENCRYPTION_KEYS_PROJECT = 2
+            end
+          end
+
+          # Settings specific to the Key Management Service.
+          # @!attribute [rw] next_rotation_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Required. Input only. Immutable. The time at which the Key Management Service will automatically create a
+          #     new version of the crypto key and mark it as the primary.
+          # @!attribute [rw] rotation_period
+          #   @return [::Google::Protobuf::Duration]
+          #     Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key
+          #     Management Service automatically rotates a key. Must be at least 24 hours
+          #     and at most 876,000 hours.
+          class KMSSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Settings specific to resources needed for IL4.
+          # @!attribute [rw] kms_settings
+          #   @return [::Google::Cloud::AssuredWorkloads::V1beta1::Workload::KMSSettings]
+          #     Required. Input only. Immutable. Settings used to create a CMEK crypto key.
+          class IL4Settings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Settings specific to resources needed for CJIS.
+          # @!attribute [rw] kms_settings
+          #   @return [::Google::Cloud::AssuredWorkloads::V1beta1::Workload::KMSSettings]
+          #     Required. Input only. Immutable. Settings used to create a CMEK crypto key.
+          class CJISSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Settings specific to resources needed for FedRAMP High.
+          # @!attribute [rw] kms_settings
+          #   @return [::Google::Cloud::AssuredWorkloads::V1beta1::Workload::KMSSettings]
+          #     Required. Input only. Immutable. Settings used to create a CMEK crypto key.
+          class FedrampHighSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Settings specific to resources needed for FedRAMP Moderate.
+          # @!attribute [rw] kms_settings
+          #   @return [::Google::Cloud::AssuredWorkloads::V1beta1::Workload::KMSSettings]
+          #     Required. Input only. Immutable. Settings used to create a CMEK crypto key.
+          class FedrampModerateSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Supported Compliance Regimes.
+          module ComplianceRegime
+            # Unknown compliance regime.
+            COMPLIANCE_REGIME_UNSPECIFIED = 0
+
+            # Information protection as per DoD IL4 requirements.
+            IL4 = 1
+
+            # Criminal Justice Information Services (CJIS) Security policies.
+            CJIS = 2
+
+            # FedRAMP High data protection controls
+            FEDRAMP_HIGH = 3
+
+            # FedRAMP Moderate data protection controls
+            FEDRAMP_MODERATE = 4
+          end
+        end
+
+        # Operation metadata to give request details of CreateWorkload.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Optional. Time when the operation was created.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. The display name of the workload.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Optional. The parent of the workload.
+        # @!attribute [rw] compliance_regime
+        #   @return [::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ComplianceRegime]
+        #     Optional. Compliance controls that should be applied to the resources managed by
+        #     the workload.
+        class CreateWorkloadOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/longrunning/operations.rb

@@ -0,0 +1,150 @@
+# 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 Longrunning
+    # This resource represents a long-running operation that is the result of a
+    # network API call.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The server-assigned name, which is only unique within the same service that
+    #     originally returns it. If you use the default HTTP mapping, the
+    #     `name` should have the format of `operations/some/unique/name`.
+    # @!attribute [rw] metadata
+    #   @return [::Google::Protobuf::Any]
+    #     Service-specific metadata associated with the operation.  It typically
+    #     contains progress information and common metadata such as create time.
+    #     Some services might not provide such metadata.  Any method that returns a
+    #     long-running operation should document the metadata type, if any.
+    # @!attribute [rw] done
+    #   @return [::Boolean]
+    #     If the value is `false`, it means the operation is still in progress.
+    #     If true, the operation is completed, and either `error` or `response` is
+    #     available.
+    # @!attribute [rw] error
+    #   @return [::Google::Rpc::Status]
+    #     The error result of the operation in case of failure or cancellation.
+    # @!attribute [rw] response
+    #   @return [::Google::Protobuf::Any]
+    #     The normal response of the operation in case of success.  If the original
+    #     method returns no data on success, such as `Delete`, the response is
+    #     `google.protobuf.Empty`.  If the original method is standard
+    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
+    #     methods, the response should have the type `XxxResponse`, where `Xxx`
+    #     is the original method name.  For example, if the original method name
+    #     is `TakeSnapshot()`, the inferred response type is
+    #     `TakeSnapshotResponse`.
+    class Operation
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.GetOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource.
+    class GetOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.ListOperations.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation collection.
+    # @!attribute [rw] filter
+    #   @return [::String]
+    #     The standard list filter.
+    # @!attribute [rw] page_size
+    #   @return [::Integer]
+    #     The standard list page size.
+    # @!attribute [rw] page_token
+    #   @return [::String]
+    #     The standard list page token.
+    class ListOperationsRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The response message for Operations.ListOperations.
+    # @!attribute [rw] operations
+    #   @return [::Array<::Google::Longrunning::Operation>]
+    #     A list of operations that matches the specified filter in the request.
+    # @!attribute [rw] next_page_token
+    #   @return [::String]
+    #     The standard List next-page token.
+    class ListOperationsResponse
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.CancelOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be cancelled.
+    class CancelOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.DeleteOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be deleted.
+    class DeleteOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A message representing the message types used by a long-running operation.
+    #
+    # Example:
+    #
+    #   rpc LongRunningRecognize(LongRunningRecognizeRequest)
+    #       returns (google.longrunning.Operation) {
+    #     option (google.longrunning.operation_info) = {
+    #       response_type: "LongRunningRecognizeResponse"
+    #       metadata_type: "LongRunningRecognizeMetadata"
+    #     };
+    #   }
+    # @!attribute [rw] response_type
+    #   @return [::String]
+    #     Required. The message name of the primary return type for this
+    #     long-running operation.
+    #     This type will be used to deserialize the LRO's response.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    # @!attribute [rw] metadata_type
+    #   @return [::String]
+    #     Required. The message name of the metadata type for this long-running
+    #     operation.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    class OperationInfo
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end