google-cloud-dataproc-v1 0.1.0

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/dataproc/v1/autoscaling_policies.rb

@@ -0,0 +1,272 @@
+# 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 Dataproc
+      module V1
+        # Describes an autoscaling policy for Dataproc cluster autoscaler.
+        # @!attribute [rw] id
+        #   @return [String]
+        #     Required. The policy id.
+        #
+        #     The id must contain only letters (a-z, A-Z), numbers (0-9),
+        #     underscores (_), and hyphens (-). Cannot begin or end with underscore
+        #     or hyphen. Must consist of between 3 and 50 characters.
+        # @!attribute [r] name
+        #   @return [String]
+        #     Output only. The "resource name" of the autoscaling policy, as described
+        #     in https://cloud.google.com/apis/design/resource_names.
+        #
+        #     * For `projects.regions.autoscalingPolicies`, the resource name of the
+        #       policy has the following format:
+        #       `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}`
+        #
+        #     * For `projects.locations.autoscalingPolicies`, the resource name of the
+        #       policy has the following format:
+        #       `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
+        # @!attribute [rw] basic_algorithm
+        #   @return [Google::Cloud::Dataproc::V1::BasicAutoscalingAlgorithm]
+        # @!attribute [rw] worker_config
+        #   @return [Google::Cloud::Dataproc::V1::InstanceGroupAutoscalingPolicyConfig]
+        #     Required. Describes how the autoscaler will operate for primary workers.
+        # @!attribute [rw] secondary_worker_config
+        #   @return [Google::Cloud::Dataproc::V1::InstanceGroupAutoscalingPolicyConfig]
+        #     Optional. Describes how the autoscaler will operate for secondary workers.
+        class AutoscalingPolicy
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Basic algorithm for autoscaling.
+        # @!attribute [rw] yarn_config
+        #   @return [Google::Cloud::Dataproc::V1::BasicYarnAutoscalingConfig]
+        #     Required. YARN autoscaling configuration.
+        # @!attribute [rw] cooldown_period
+        #   @return [Google::Protobuf::Duration]
+        #     Optional. Duration between scaling events. A scaling period starts after
+        #     the update operation from the previous event has completed.
+        #
+        #     Bounds: [2m, 1d]. Default: 2m.
+        class BasicAutoscalingAlgorithm
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Basic autoscaling configurations for YARN.
+        # @!attribute [rw] graceful_decommission_timeout
+        #   @return [Google::Protobuf::Duration]
+        #     Required. Timeout for YARN graceful decommissioning of Node Managers.
+        #     Specifies the duration to wait for jobs to complete before forcefully
+        #     removing workers (and potentially interrupting jobs). Only applicable to
+        #     downscaling operations.
+        #
+        #     Bounds: [0s, 1d].
+        # @!attribute [rw] scale_up_factor
+        #   @return [Float]
+        #     Required. Fraction of average pending memory in the last cooldown period
+        #     for which to add workers. A scale-up factor of 1.0 will result in scaling
+        #     up so that there is no pending memory remaining after the update (more
+        #     aggressive scaling). A scale-up factor closer to 0 will result in a smaller
+        #     magnitude of scaling up (less aggressive scaling).
+        #
+        #     Bounds: [0.0, 1.0].
+        # @!attribute [rw] scale_down_factor
+        #   @return [Float]
+        #     Required. Fraction of average pending memory in the last cooldown period
+        #     for which to remove workers. A scale-down factor of 1 will result in
+        #     scaling down so that there is no available memory remaining after the
+        #     update (more aggressive scaling). A scale-down factor of 0 disables
+        #     removing workers, which can be beneficial for autoscaling a single job.
+        #
+        #     Bounds: [0.0, 1.0].
+        # @!attribute [rw] scale_up_min_worker_fraction
+        #   @return [Float]
+        #     Optional. Minimum scale-up threshold as a fraction of total cluster size
+        #     before scaling occurs. For example, in a 20-worker cluster, a threshold of
+        #     0.1 means the autoscaler must recommend at least a 2-worker scale-up for
+        #     the cluster to scale. A threshold of 0 means the autoscaler will scale up
+        #     on any recommended change.
+        #
+        #     Bounds: [0.0, 1.0]. Default: 0.0.
+        # @!attribute [rw] scale_down_min_worker_fraction
+        #   @return [Float]
+        #     Optional. Minimum scale-down threshold as a fraction of total cluster size
+        #     before scaling occurs. For example, in a 20-worker cluster, a threshold of
+        #     0.1 means the autoscaler must recommend at least a 2 worker scale-down for
+        #     the cluster to scale. A threshold of 0 means the autoscaler will scale down
+        #     on any recommended change.
+        #
+        #     Bounds: [0.0, 1.0]. Default: 0.0.
+        class BasicYarnAutoscalingConfig
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration for the size bounds of an instance group, including its
+        # proportional size to other groups.
+        # @!attribute [rw] min_instances
+        #   @return [Integer]
+        #     Optional. Minimum number of instances for this group.
+        #
+        #     Primary workers - Bounds: [2, max_instances]. Default: 2.
+        #     Secondary workers - Bounds: [0, max_instances]. Default: 0.
+        # @!attribute [rw] max_instances
+        #   @return [Integer]
+        #     Required. Maximum number of instances for this group. Required for primary
+        #     workers. Note that by default, clusters will not use secondary workers.
+        #     Required for secondary workers if the minimum secondary instances is set.
+        #
+        #     Primary workers - Bounds: [min_instances, ).
+        #     Secondary workers - Bounds: [min_instances, ). Default: 0.
+        # @!attribute [rw] weight
+        #   @return [Integer]
+        #     Optional. Weight for the instance group, which is used to determine the
+        #     fraction of total workers in the cluster from this instance group.
+        #     For example, if primary workers have weight 2, and secondary workers have
+        #     weight 1, the cluster will have approximately 2 primary workers for each
+        #     secondary worker.
+        #
+        #     The cluster may not reach the specified balance if constrained
+        #     by min/max bounds or other autoscaling settings. For example, if
+        #     `max_instances` for secondary workers is 0, then only primary workers will
+        #     be added. The cluster can also be out of balance when created.
+        #
+        #     If weight is not set on any instance group, the cluster will default to
+        #     equal weight for all groups: the cluster will attempt to maintain an equal
+        #     number of workers in each group within the configured size bounds for each
+        #     group. If weight is set for one group only, the cluster will default to
+        #     zero weight on the unset group. For example if weight is set only on
+        #     primary workers, the cluster will use primary workers only and no
+        #     secondary workers.
+        class InstanceGroupAutoscalingPolicyConfig
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request to create an autoscaling policy.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Required. The "resource name" of the region or location, as described
+        #     in https://cloud.google.com/apis/design/resource_names.
+        #
+        #     * For `projects.regions.autoscalingPolicies.create`, the resource name
+        #       of the region has the following format:
+        #       `projects/{project_id}/regions/{region}`
+        #
+        #     * For `projects.locations.autoscalingPolicies.create`, the resource name
+        #       of the location has the following format:
+        #       `projects/{project_id}/locations/{location}`
+        # @!attribute [rw] policy
+        #   @return [Google::Cloud::Dataproc::V1::AutoscalingPolicy]
+        #     Required. The autoscaling policy to create.
+        class CreateAutoscalingPolicyRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request to fetch an autoscaling policy.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. The "resource name" of the autoscaling policy, as described
+        #     in https://cloud.google.com/apis/design/resource_names.
+        #
+        #     * For `projects.regions.autoscalingPolicies.get`, the resource name
+        #       of the policy has the following format:
+        #       `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}`
+        #
+        #     * For `projects.locations.autoscalingPolicies.get`, the resource name
+        #       of the policy has the following format:
+        #       `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
+        class GetAutoscalingPolicyRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request to update an autoscaling policy.
+        # @!attribute [rw] policy
+        #   @return [Google::Cloud::Dataproc::V1::AutoscalingPolicy]
+        #     Required. The updated autoscaling policy.
+        class UpdateAutoscalingPolicyRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request to delete an autoscaling policy.
+        #
+        # Autoscaling policies in use by one or more clusters will not be deleted.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. The "resource name" of the autoscaling policy, as described
+        #     in https://cloud.google.com/apis/design/resource_names.
+        #
+        #     * For `projects.regions.autoscalingPolicies.delete`, the resource name
+        #       of the policy has the following format:
+        #       `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}`
+        #
+        #     * For `projects.locations.autoscalingPolicies.delete`, the resource name
+        #       of the policy has the following format:
+        #       `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
+        class DeleteAutoscalingPolicyRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request to list autoscaling policies in a project.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Required. The "resource name" of the region or location, as described
+        #     in https://cloud.google.com/apis/design/resource_names.
+        #
+        #     * For `projects.regions.autoscalingPolicies.list`, the resource name
+        #       of the region has the following format:
+        #       `projects/{project_id}/regions/{region}`
+        #
+        #     * For `projects.locations.autoscalingPolicies.list`, the resource name
+        #       of the location has the following format:
+        #       `projects/{project_id}/locations/{location}`
+        # @!attribute [rw] page_size
+        #   @return [Integer]
+        #     Optional. The maximum number of results to return in each response.
+        #     Must be less than or equal to 1000. Defaults to 100.
+        # @!attribute [rw] page_token
+        #   @return [String]
+        #     Optional. The page token, returned by a previous call, to request the
+        #     next page of results.
+        class ListAutoscalingPoliciesRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A response to a request to list autoscaling policies in a project.
+        # @!attribute [r] policies
+        #   @return [Array<Google::Cloud::Dataproc::V1::AutoscalingPolicy>]
+        #     Output only. Autoscaling policies list.
+        # @!attribute [r] next_page_token
+        #   @return [String]
+        #     Output only. This token is included in the response if there are more
+        #     results to fetch.
+        class ListAutoscalingPoliciesResponse
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end