google-cloud-eventarc-v1 0.1.0

data/proto_docs/google/cloud/eventarc/v1/eventarc.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Eventarc
+      module V1
+        # The request message for the GetTrigger method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the trigger to get.
+        class GetTriggerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for the ListTriggers method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent collection to list triggers on.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of triggers to return on each page.
+        #     Note: The service may send fewer.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     The page token; provide the value from the `next_page_token` field in a
+        #     previous `ListTriggers` call to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to `ListTriggers` must match
+        #     the call that provided the page token.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     The sorting order of the resources returned. Value should be a comma
+        #     separated list of fields. The default sorting oder is ascending. To specify
+        #     descending order for a field, append a ` desc` suffix; for example:
+        #     `name desc, trigger_id`.
+        class ListTriggersRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response message for the ListTriggers method.
+        # @!attribute [rw] triggers
+        #   @return [::Array<::Google::Cloud::Eventarc::V1::Trigger>]
+        #     The requested triggers, up to the number specified in `page_size`.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A page token that can be sent to ListTriggers to request the next page.
+        #     If this is empty, then there are no more pages.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Unreachable resources, if any.
+        class ListTriggersResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for the CreateTrigger method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent collection in which to add this trigger.
+        # @!attribute [rw] trigger
+        #   @return [::Google::Cloud::Eventarc::V1::Trigger]
+        #     Required. The trigger to create.
+        # @!attribute [rw] trigger_id
+        #   @return [::String]
+        #     Required. The user-provided ID to be assigned to the trigger.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     Required. If set, validate the request and preview the review, but do not actually
+        #     post it.
+        class CreateTriggerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for the UpdateTrigger method.
+        # @!attribute [rw] trigger
+        #   @return [::Google::Cloud::Eventarc::V1::Trigger]
+        #     The trigger to be updated.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     The fields to be updated; only fields explicitly provided will be updated.
+        #     If no field mask is provided, all provided fields in the request will be
+        #     updated. To update all fields, provide a field mask of "*".
+        # @!attribute [rw] allow_missing
+        #   @return [::Boolean]
+        #     If set to true, and the trigger is not found, a new trigger will be
+        #     created. In this situation, `update_mask` is ignored.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     Required. If set, validate the request and preview the review, but do not actually
+        #     post it.
+        class UpdateTriggerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for the DeleteTrigger method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the trigger to be deleted.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     If provided, the trigger will only be deleted if the etag matches the
+        #     current etag on the resource.
+        # @!attribute [rw] allow_missing
+        #   @return [::Boolean]
+        #     If set to true, and the trigger is not found, the request will succeed
+        #     but no action will be taken on the server.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     Required. If set, validate the request and preview the review, but do not actually
+        #     post it.
+        class DeleteTriggerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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.
+        class OperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/eventarc/v1/trigger.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Eventarc
+      module V1
+        # A representation of the trigger resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the trigger. Must be unique within the
+        #     location on the project and must be in
+        #     `projects/{project}/locations/{location}/triggers/{trigger}` format.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. Server assigned unique identifier for the trigger. The value
+        #     is a UUID4 string and guaranteed to remain unchanged until the resource is
+        #     deleted.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The creation time.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The last-modified time.
+        # @!attribute [rw] event_filters
+        #   @return [::Array<::Google::Cloud::Eventarc::V1::EventFilter>]
+        #     Required. null The list of filters that applies to event attributes. Only
+        #     events that match all the provided filters will be sent to the destination.
+        # @!attribute [rw] service_account
+        #   @return [::String]
+        #     Optional. The IAM service account email associated with the trigger. The
+        #     service account represents the identity of the trigger.
+        #
+        #     The principal who calls this API must have `iam.serviceAccounts.actAs`
+        #     permission in the service account. See
+        #     https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common
+        #     for more information.
+        #
+        #     For Cloud Run destinations, this service account is used to generate
+        #     identity tokens when invoking the service. See
+        #     https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account
+        #     for information on how to invoke authenticated Cloud Run services.
+        #     In order to create Audit Log triggers, the service account should also
+        #     have `roles/eventarc.eventReceiver` IAM role.
+        # @!attribute [rw] destination
+        #   @return [::Google::Cloud::Eventarc::V1::Destination]
+        #     Required. Destination specifies where the events should be sent to.
+        # @!attribute [rw] transport
+        #   @return [::Google::Cloud::Eventarc::V1::Transport]
+        #     Optional. In order to deliver messages, Eventarc may use other GCP
+        #     products as transport intermediary. This field contains a reference to that
+        #     transport intermediary. This information can be used for debugging
+        #     purposes.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. User labels attached to the triggers that can be used to group
+        #     resources.
+        # @!attribute [r] etag
+        #   @return [::String]
+        #     Output only. This checksum is computed by the server based on the value of
+        #     other fields, and may be sent only on create requests to ensure the client
+        #     has an up-to-date value before proceeding.
+        class Trigger
+          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
+
+        # Filters events based on exact matches on the CloudEvents attributes.
+        # @!attribute [rw] attribute
+        #   @return [::String]
+        #     Required. The name of a CloudEvents attribute. Currently, only a subset of
+        #     attributes are supported for filtering.
+        #
+        #     All triggers MUST provide a filter for the 'type' attribute.
+        # @!attribute [rw] value
+        #   @return [::String]
+        #     Required. The value for the attribute.
+        class EventFilter
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents a target of an invocation over HTTP.
+        # @!attribute [rw] cloud_run
+        #   @return [::Google::Cloud::Eventarc::V1::CloudRun]
+        #     Cloud Run fully-managed service that receives the events. The service
+        #     should be running in the same project of the trigger.
+        class Destination
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents the transport intermediaries created for the trigger in order to
+        # deliver events.
+        # @!attribute [rw] pubsub
+        #   @return [::Google::Cloud::Eventarc::V1::Pubsub]
+        #     The Pub/Sub topic and subscription used by Eventarc as delivery
+        #     intermediary.
+        class Transport
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents a Cloud Run destination.
+        # @!attribute [rw] service
+        #   @return [::String]
+        #     Required. The name of the Cloud Run service being addressed. See
+        #     https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services.
+        #
+        #     Only services located in the same project of the trigger object
+        #     can be addressed.
+        # @!attribute [rw] path
+        #   @return [::String]
+        #     Optional. The relative path on the Cloud Run service the events should be
+        #     sent to.
+        #
+        #     The value must conform to the definition of URI path segment (section 3.3
+        #     of RFC2396). Examples: "/route", "route", "route/subroute".
+        # @!attribute [rw] region
+        #   @return [::String]
+        #     Required. The region the Cloud Run service is deployed in.
+        class CloudRun
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents a Pub/Sub transport.
+        # @!attribute [rw] topic
+        #   @return [::String]
+        #     Optional. The name of the Pub/Sub topic created and managed by Eventarc
+        #     system as a transport for the event delivery. Format:
+        #     `projects/{PROJECT_ID}/topics/{TOPIC_NAME}`.
+        #
+        #     You may set an existing topic for triggers of the type
+        #     `google.cloud.pubsub.topic.v1.messagePublished` only. The topic you provide
+        #     here will not be deleted by Eventarc at trigger deletion.
+        # @!attribute [r] subscription
+        #   @return [::String]
+        #     Output only. The name of the Pub/Sub subscription created and managed by
+        #     Eventarc system as a transport for the event delivery. Format:
+        #     `projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_NAME}`.
+        class Pubsub
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/longrunning/operations.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 be a resource name ending with `operations/{unique_id}`.
+    # @!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's parent resource.
+    # @!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
+
+    # The request message for Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     The maximum duration to wait before timing out. If left blank, the wait
+    #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+    #     If RPC context deadline is also specified, the shorter one will be used.
+    class WaitOperationRequest
+      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