google-cloud-gaming-v1 0.6.0 → 1.0.0

data/proto_docs/google/api/resource.rb

@@ -1,222 +0,0 @@
-# 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"
-    #         pattern: "projects/{project}/topics/{topic}"
-    #       };
-    #     }
-    #
-    # The ResourceDescriptor Yaml config will look like:
-    #
-    #     resources:
-    #     - type: "pubsub.googleapis.com/Topic"
-    #       pattern: "projects/{project}/topics/{topic}"
-    #
-    # 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"
-    #         pattern: "projects/{project}/logs/{log}"
-    #         pattern: "folders/{folder}/logs/{log}"
-    #         pattern: "organizations/{organization}/logs/{log}"
-    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #       };
-    #     }
-    #
-    # The ResourceDescriptor Yaml config will look like:
-    #
-    #     resources:
-    #     - type: 'logging.googleapis.com/LogEntry'
-    #       pattern: "projects/{project}/logs/{log}"
-    #       pattern: "folders/{folder}/logs/{log}"
-    #       pattern: "organizations/{organization}/logs/{log}"
-    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
-    # @!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 and permission names, such as
-    #     'projects' for the resource name of 'projects/\\{project}' and the permission
-    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. 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/
-    #
-    #     Note: The plural form is required even for singleton resources. See
-    #     https://aip.dev/156
-    # @!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.
-    # @!attribute [rw] style
-    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
-    #     Style flag(s) for this resource.
-    #     These indicate that a resource is expected to conform to a given
-    #     style. See the specific style flags for additional information.
-    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
-
-      # A flag representing a specific style that a resource claims to conform to.
-      module Style
-        # The unspecified value. Do not use.
-        STYLE_UNSPECIFIED = 0
-
-        # This resource is intended to be "declarative-friendly".
-        #
-        # Declarative-friendly resources must be more strictly consistent, and
-        # setting this to true communicates to tools that this resource should
-        # adhere to declarative-friendly expectations.
-        #
-        # Note: This is used by the API linter (linter.aip.dev) to enable
-        # additional checks.
-        DECLARATIVE_FRIENDLY = 1
-      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"
-    #           }];
-    #         }
-    #
-    #     Occasionally, a field may reference an arbitrary resource. In this case,
-    #     APIs use the special value * in their resource reference.
-    #
-    #     Example:
-    #
-    #         message GetIamPolicyRequest {
-    #           string resource = 2 [(google.api.resource_reference) = {
-    #             type: "*"
-    #           }];
-    #         }
-    # @!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/gaming/v1/common.rb

@@ -1,302 +0,0 @@
-# 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 Gaming
-      module V1
-        # Represents the metadata of the long-running operation.
-        # @!attribute [r] create_time
-        #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The time the operation was created.
-        # @!attribute [r] end_time
-        #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The time the operation finished running.
-        # @!attribute [r] target
-        #   @return [::String]
-        #     Output only. Server-defined resource path for the target of the operation.
-        # @!attribute [r] verb
-        #   @return [::String]
-        #     Output only. Name of the verb executed by the operation.
-        # @!attribute [r] status_message
-        #   @return [::String]
-        #     Output only. Human-readable status of the operation, if any.
-        # @!attribute [r] requested_cancellation
-        #   @return [::Boolean]
-        #     Output only. Identifies whether the user has requested cancellation
-        #     of the operation. Operations that have successfully been cancelled
-        #     have [Operation.error][] value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
-        #     corresponding to `Code.CANCELLED`.
-        # @!attribute [r] api_version
-        #   @return [::String]
-        #     Output only. API version used to start the operation.
-        # @!attribute [r] unreachable
-        #   @return [::Array<::String>]
-        #     Output only. List of Locations that could not be reached.
-        # @!attribute [r] operation_status
-        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Gaming::V1::OperationStatus}]
-        #     Output only. Operation status for Game Services API operations. Operation status is in
-        #     the form of key-value pairs where keys are resource IDs and the values show
-        #     the status of the operation. In case of failures, the value includes an
-        #     error code and error message.
-        class OperationMetadata
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-
-          # @!attribute [rw] key
-          #   @return [::String]
-          # @!attribute [rw] value
-          #   @return [::Google::Cloud::Gaming::V1::OperationStatus]
-          class OperationStatusEntry
-            include ::Google::Protobuf::MessageExts
-            extend ::Google::Protobuf::MessageExts::ClassMethods
-          end
-        end
-
-        # @!attribute [r] done
-        #   @return [::Boolean]
-        #     Output only. Whether the operation is done or still in progress.
-        # @!attribute [rw] error_code
-        #   @return [::Google::Cloud::Gaming::V1::OperationStatus::ErrorCode]
-        #     The error code in case of failures.
-        # @!attribute [rw] error_message
-        #   @return [::String]
-        #     The human-readable error message.
-        class OperationStatus
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-
-          module ErrorCode
-            ERROR_CODE_UNSPECIFIED = 0
-
-            INTERNAL_ERROR = 1
-
-            PERMISSION_DENIED = 2
-
-            CLUSTER_CONNECTION = 3
-          end
-        end
-
-        # The label selector, used to group labels on the resources.
-        # @!attribute [rw] labels
-        #   @return [::Google::Protobuf::Map{::String => ::String}]
-        #     Resource labels for this selector.
-        class LabelSelector
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-
-          # @!attribute [rw] key
-          #   @return [::String]
-          # @!attribute [rw] value
-          #   @return [::String]
-          class LabelsEntry
-            include ::Google::Protobuf::MessageExts
-            extend ::Google::Protobuf::MessageExts::ClassMethods
-          end
-        end
-
-        # The realm selector, used to match realm resources.
-        # @!attribute [rw] realms
-        #   @return [::Array<::String>]
-        #     List of realms to match.
-        class RealmSelector
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # The schedule of a recurring or one time event. The event's time span is
-        # specified by start_time and end_time. If the scheduled event's timespan is
-        # larger than the cron_spec + cron_job_duration, the event will be recurring.
-        # If only cron_spec + cron_job_duration are specified, the event is effective
-        # starting at the local time specified by cron_spec, and is recurring.
-        #
-        # ```
-        # start_time|-------[cron job]-------[cron job]-------[cron job]---|end_time
-        # cron job: cron spec start time + duration
-        # ```
-        # @!attribute [rw] start_time
-        #   @return [::Google::Protobuf::Timestamp]
-        #     The start time of the event.
-        # @!attribute [rw] end_time
-        #   @return [::Google::Protobuf::Timestamp]
-        #     The end time of the event.
-        # @!attribute [rw] cron_job_duration
-        #   @return [::Google::Protobuf::Duration]
-        #     The duration for the cron job event. The duration of the event is effective
-        #     after the cron job's start time.
-        # @!attribute [rw] cron_spec
-        #   @return [::String]
-        #     The cron definition of the scheduled event. See
-        #     https://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as
-        #     defined by the realm.
-        class Schedule
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Encapsulates Agones fleet spec and Agones autoscaler spec sources.
-        # @!attribute [rw] game_server_config_name
-        #   @return [::String]
-        #     The game server config resource. Uses the form:
-        #     `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
-        # @!attribute [rw] name
-        #   @return [::String]
-        #     The name of the Agones leet config or Agones scaling config used to derive
-        #     the Agones fleet or Agones autoscaler spec.
-        class SpecSource
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Details about the Agones resources.
-        # @!attribute [rw] game_server_cluster_name
-        #   @return [::String]
-        #     The game server cluster name. Uses the form:
-        #     `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
-        # @!attribute [rw] game_server_deployment_name
-        #   @return [::String]
-        #     The game server deployment name. Uses the form:
-        #     `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
-        # @!attribute [rw] fleet_details
-        #   @return [::Array<::Google::Cloud::Gaming::V1::TargetDetails::TargetFleetDetails>]
-        #     Agones fleet details for game server clusters and game server deployments.
-        class TargetDetails
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-
-          # Details of the target Agones fleet.
-          # @!attribute [rw] fleet
-          #   @return [::Google::Cloud::Gaming::V1::TargetDetails::TargetFleetDetails::TargetFleet]
-          #     Reference to target Agones fleet.
-          # @!attribute [rw] autoscaler
-          #   @return [::Google::Cloud::Gaming::V1::TargetDetails::TargetFleetDetails::TargetFleetAutoscaler]
-          #     Reference to target Agones fleet autoscaling policy.
-          class TargetFleetDetails
-            include ::Google::Protobuf::MessageExts
-            extend ::Google::Protobuf::MessageExts::ClassMethods
-
-            # Target Agones fleet specification.
-            # @!attribute [rw] name
-            #   @return [::String]
-            #     The name of the Agones fleet.
-            # @!attribute [rw] spec_source
-            #   @return [::Google::Cloud::Gaming::V1::SpecSource]
-            #     Encapsulates the source of the Agones fleet spec.
-            #     The Agones fleet spec source.
-            class TargetFleet
-              include ::Google::Protobuf::MessageExts
-              extend ::Google::Protobuf::MessageExts::ClassMethods
-            end
-
-            # Target Agones autoscaler policy reference.
-            # @!attribute [rw] name
-            #   @return [::String]
-            #     The name of the Agones autoscaler.
-            # @!attribute [rw] spec_source
-            #   @return [::Google::Cloud::Gaming::V1::SpecSource]
-            #     Encapsulates the source of the Agones fleet spec.
-            #     Details about the Agones autoscaler spec.
-            class TargetFleetAutoscaler
-              include ::Google::Protobuf::MessageExts
-              extend ::Google::Protobuf::MessageExts::ClassMethods
-            end
-          end
-        end
-
-        # Encapsulates the Target state.
-        # @!attribute [rw] details
-        #   @return [::Array<::Google::Cloud::Gaming::V1::TargetDetails>]
-        #     Details about Agones fleets.
-        class TargetState
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Details of the deployed Agones fleet.
-        # @!attribute [rw] deployed_fleet
-        #   @return [::Google::Cloud::Gaming::V1::DeployedFleetDetails::DeployedFleet]
-        #     Information about the Agones fleet.
-        # @!attribute [rw] deployed_autoscaler
-        #   @return [::Google::Cloud::Gaming::V1::DeployedFleetDetails::DeployedFleetAutoscaler]
-        #     Information about the Agones autoscaler for that fleet.
-        class DeployedFleetDetails
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-
-          # Agones fleet specification and details.
-          # @!attribute [rw] fleet
-          #   @return [::String]
-          #     The name of the Agones fleet.
-          # @!attribute [rw] fleet_spec
-          #   @return [::String]
-          #     The fleet spec retrieved from the Agones fleet.
-          # @!attribute [rw] spec_source
-          #   @return [::Google::Cloud::Gaming::V1::SpecSource]
-          #     The source spec that is used to create the Agones fleet.
-          #     The GameServerConfig resource may no longer exist in the system.
-          # @!attribute [rw] status
-          #   @return [::Google::Cloud::Gaming::V1::DeployedFleetDetails::DeployedFleet::DeployedFleetStatus]
-          #     The current status of the Agones fleet.
-          #     Includes count of game servers in various states.
-          class DeployedFleet
-            include ::Google::Protobuf::MessageExts
-            extend ::Google::Protobuf::MessageExts::ClassMethods
-
-            # DeployedFleetStatus has details about the Agones fleets such as how many
-            # are running, how many allocated, and so on.
-            # @!attribute [rw] ready_replicas
-            #   @return [::Integer]
-            #     The number of GameServer replicas in the READY state in this fleet.
-            # @!attribute [rw] allocated_replicas
-            #   @return [::Integer]
-            #     The number of GameServer replicas in the ALLOCATED state in this fleet.
-            # @!attribute [rw] reserved_replicas
-            #   @return [::Integer]
-            #     The number of GameServer replicas in the RESERVED state in this fleet.
-            #     Reserved instances won't be deleted on scale down, but won't cause
-            #     an autoscaler to scale up.
-            # @!attribute [rw] replicas
-            #   @return [::Integer]
-            #     The total number of current GameServer replicas in this fleet.
-            class DeployedFleetStatus
-              include ::Google::Protobuf::MessageExts
-              extend ::Google::Protobuf::MessageExts::ClassMethods
-            end
-          end
-
-          # Details about the Agones autoscaler.
-          # @!attribute [rw] autoscaler
-          #   @return [::String]
-          #     The name of the Agones autoscaler.
-          # @!attribute [rw] spec_source
-          #   @return [::Google::Cloud::Gaming::V1::SpecSource]
-          #     The source spec that is used to create the autoscaler.
-          #     The GameServerConfig resource may no longer exist in the system.
-          # @!attribute [rw] fleet_autoscaler_spec
-          #   @return [::String]
-          #     The autoscaler spec retrieved from Agones.
-          class DeployedFleetAutoscaler
-            include ::Google::Protobuf::MessageExts
-            extend ::Google::Protobuf::MessageExts::ClassMethods
-          end
-        end
-      end
-    end
-  end
-end