google-cloud-managed_kafka-v1 0.a → 0.1.0

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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/managedkafka/v1/managed_kafka.rb

@@ -0,0 +1,341 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 ManagedKafka
+      module V1
+        # Request for ListClusters.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent location whose clusters are to be listed. Structured
+        #     like `projects/{project}/locations/{location}`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of clusters to return. The service may return
+        #     fewer than this value. If unspecified, server will pick an appropriate
+        #     default.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListClusters` call.
+        #     Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to `ListClusters` must match
+        #     the call that provided the page token.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Filter expression for the result.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Order by fields for the result.
+        class ListClustersRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for ListClusters.
+        # @!attribute [rw] clusters
+        #   @return [::Array<::Google::Cloud::ManagedKafka::V1::Cluster>]
+        #     The list of Clusters in the requested parent.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as `page_token` to retrieve the next page of
+        #     results. If this field is omitted, there are no more results.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Locations that could not be reached.
+        class ListClustersResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for GetCluster.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the cluster whose configuration to return.
+        class GetClusterRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for CreateCluster.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent region in which to create the cluster. Structured like
+        #     `projects/{project}/locations/{location}`.
+        # @!attribute [rw] cluster_id
+        #   @return [::String]
+        #     Required. The ID to use for the cluster, which will become the final
+        #     component of the cluster's name. The ID must be 1-63 characters long, and
+        #     match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with
+        #     RFC 1035.
+        #
+        #     This value is structured like: `my-cluster-id`.
+        # @!attribute [rw] cluster
+        #   @return [::Google::Cloud::ManagedKafka::V1::Cluster]
+        #     Required. Configuration of the cluster to create. Its `name` field is
+        #     ignored.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique
+        #     request ID to avoid duplication of requests. If a request times out or
+        #     fails, retrying with the same ID allows the server to recognize the
+        #     previous attempt. For at least 60 minutes, the server ignores duplicate
+        #     requests bearing the same ID.
+        #
+        #     For example, consider a situation where you make an initial request and the
+        #     request times out. If you make the request again with the same request ID
+        #     within 60 minutes of the last request, the server checks if an original
+        #     operation with the same request ID was received. If so, the server ignores
+        #     the second request.
+        #
+        #     The request ID must be a valid UUID. A zero UUID is not supported
+        #     (00000000-0000-0000-0000-000000000000).
+        class CreateClusterRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for UpdateCluster.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. Field mask is used to specify the fields to be overwritten in the
+        #     cluster resource by the update. The fields specified in the update_mask are
+        #     relative to the resource, not the full request. A field will be overwritten
+        #     if it is in the mask. The mask is required and a value of * will update all
+        #     fields.
+        # @!attribute [rw] cluster
+        #   @return [::Google::Cloud::ManagedKafka::V1::Cluster]
+        #     Required. The cluster to update. Its `name` field must be populated.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique
+        #     request ID to avoid duplication of requests. If a request times out or
+        #     fails, retrying with the same ID allows the server to recognize the
+        #     previous attempt. For at least 60 minutes, the server ignores duplicate
+        #     requests bearing the same ID.
+        #
+        #     For example, consider a situation where you make an initial request and the
+        #     request times out. If you make the request again with the same request ID
+        #     within 60 minutes of the last request, the server checks if an original
+        #     operation with the same request ID was received. If so, the server ignores
+        #     the second request.
+        #
+        #     The request ID must be a valid UUID. A zero UUID is not supported
+        #     (00000000-0000-0000-0000-000000000000).
+        class UpdateClusterRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for DeleteCluster.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the cluster to delete.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique
+        #     request ID to avoid duplication of requests. If a request times out or
+        #     fails, retrying with the same ID allows the server to recognize the
+        #     previous attempt. For at least 60 minutes, the server ignores duplicate
+        #     requests bearing the same ID.
+        #
+        #     For example, consider a situation where you make an initial request and the
+        #     request times out. If you make the request again with the same request ID
+        #     within 60 minutes of the last request, the server checks if an original
+        #     operation with the same request ID was received. If so, the server ignores
+        #     the second request.
+        #
+        #     The request ID must be a valid UUID. A zero UUID is not supported
+        #     (00000000-0000-0000-0000-000000000000).
+        class DeleteClusterRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for ListTopics.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent cluster whose topics are to be listed. Structured like
+        #     `projects/{project}/locations/{location}/clusters/{cluster}`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of topics to return. The service may return
+        #     fewer than this value. If unset or zero, all topics for the parent is
+        #     returned.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListTopics` call.
+        #     Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to `ListTopics` must match
+        #     the call that provided the page token.
+        class ListTopicsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for ListTopics.
+        # @!attribute [rw] topics
+        #   @return [::Array<::Google::Cloud::ManagedKafka::V1::Topic>]
+        #     The list of topics in the requested parent. The order of the topics is
+        #     unspecified.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as `page_token` to retrieve the next page of
+        #     results. If this field is omitted, there are no more results.
+        class ListTopicsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for GetTopic.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the topic whose configuration to return. Structured
+        #     like:
+        #     projects/\\{project}/locations/\\{location}/clusters/\\{cluster}/topics/\\{topic}.
+        class GetTopicRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for CreateTopic.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent cluster in which to create the topic.
+        #     Structured like
+        #     `projects/{project}/locations/{location}/clusters/{cluster}`.
+        # @!attribute [rw] topic_id
+        #   @return [::String]
+        #     Required. The ID to use for the topic, which will become the final
+        #     component of the topic's name.
+        #
+        #     This value is structured like: `my-topic-name`.
+        # @!attribute [rw] topic
+        #   @return [::Google::Cloud::ManagedKafka::V1::Topic]
+        #     Required. Configuration of the topic to create. Its `name` field is
+        #     ignored.
+        class CreateTopicRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for UpdateTopic.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. Field mask is used to specify the fields to be overwritten in the
+        #     Topic resource by the update. The fields specified in the update_mask are
+        #     relative to the resource, not the full request. A field will be overwritten
+        #     if it is in the mask. The mask is required and a value of * will update all
+        #     fields.
+        # @!attribute [rw] topic
+        #   @return [::Google::Cloud::ManagedKafka::V1::Topic]
+        #     Required. The topic to update. Its `name` field must be populated.
+        class UpdateTopicRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for DeleteTopic.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the topic to delete.
+        #     `projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}`.
+        class DeleteTopicRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for ListConsumerGroups.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent cluster whose consumer groups are to be listed.
+        #     Structured like
+        #     `projects/{project}/locations/{location}/clusters/{cluster}`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of consumer groups to return. The service may
+        #     return fewer than this value. If unset or zero, all consumer groups for the
+        #     parent is returned.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListConsumerGroups` call.
+        #     Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to `ListConsumerGroups` must
+        #     match the call that provided the page token.
+        class ListConsumerGroupsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for ListConsumerGroups.
+        # @!attribute [rw] consumer_groups
+        #   @return [::Array<::Google::Cloud::ManagedKafka::V1::ConsumerGroup>]
+        #     The list of consumer group in the requested parent. The order of the
+        #     consumer groups is unspecified.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as `page_token` to retrieve the next page of
+        #     results. If this field is omitted, there are no more results.
+        class ListConsumerGroupsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for GetConsumerGroup.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the consumer group whose configuration to return.
+        #     `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`.
+        class GetConsumerGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for UpdateConsumerGroup.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. Field mask is used to specify the fields to be overwritten in the
+        #     ConsumerGroup resource by the update.
+        #     The fields specified in the update_mask are relative to the resource, not
+        #     the full request. A field will be overwritten if it is in the mask. The
+        #     mask is required and a value of * will update all fields.
+        # @!attribute [rw] consumer_group
+        #   @return [::Google::Cloud::ManagedKafka::V1::ConsumerGroup]
+        #     Required. The consumer group to update. Its `name` field must be populated.
+        class UpdateConsumerGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for DeleteConsumerGroup.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the consumer group to delete.
+        #     `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`.
+        class DeleteConsumerGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end