google-cloud-scheduler-v1 0.1.0

data/lib/google/cloud/scheduler/v1/cloud_scheduler/credentials.rb

@@ -0,0 +1,51 @@
+# 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!
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module Scheduler
+      module V1
+        module CloudScheduler
+          # Credentials for the CloudScheduler API.
+          class Credentials < ::Google::Auth::Credentials
+            self.scope = [
+              "https://www.googleapis.com/auth/cloud-platform"
+            ]
+            self.env_vars = [
+              "SCHEDULER_CREDENTIALS",
+              "SCHEDULER_KEYFILE",
+              "GOOGLE_CLOUD_CREDENTIALS",
+              "GOOGLE_CLOUD_KEYFILE",
+              "GCLOUD_KEYFILE",
+              "SCHEDULER_CREDENTIALS_JSON",
+              "SCHEDULER_KEYFILE_JSON",
+              "GOOGLE_CLOUD_CREDENTIALS_JSON",
+              "GOOGLE_CLOUD_KEYFILE_JSON",
+              "GCLOUD_KEYFILE_JSON"
+            ]
+            self.paths = [
+              "~/.config/google_cloud/application_default_credentials.json"
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/scheduler/v1/cloud_scheduler/paths.rb

@@ -0,0 +1,86 @@
+# 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 Scheduler
+      module V1
+        module CloudScheduler
+          # Path helper methods for the CloudScheduler API.
+          module Paths
+            ##
+            # Create a fully-qualified Job resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/jobs/{job}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param job [String]
+            #
+            # @return [::String]
+            def job_path project:, location:, job:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/jobs/#{job}"
+            end
+
+            ##
+            # Create a fully-qualified Location resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}`
+            #
+            # @param project [String]
+            # @param location [String]
+            #
+            # @return [::String]
+            def location_path project:, location:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}"
+            end
+
+            ##
+            # Create a fully-qualified Topic resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/topics/{topic}`
+            #
+            # @param project [String]
+            # @param topic [String]
+            #
+            # @return [::String]
+            def topic_path project:, topic:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/topics/#{topic}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/scheduler/v1/cloud_scheduler.rb

@@ -0,0 +1,50 @@
+# 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!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/scheduler/v1/version"
+
+require "google/cloud/scheduler/v1/cloud_scheduler/credentials"
+require "google/cloud/scheduler/v1/cloud_scheduler/paths"
+require "google/cloud/scheduler/v1/cloud_scheduler/client"
+
+module Google
+  module Cloud
+    module Scheduler
+      module V1
+        ##
+        # The Cloud Scheduler API allows external entities to reliably
+        # schedule asynchronous jobs.
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/scheduler/v1/cloud_scheduler"
+        #     client = ::Google::Cloud::Scheduler::V1::CloudScheduler::Client.new
+        #
+        module CloudScheduler
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "cloud_scheduler", "helpers.rb"
+require "google/cloud/scheduler/v1/cloud_scheduler/helpers" if ::File.file? helper_path

data/lib/google/cloud/scheduler/v1/cloudscheduler_pb.rb

@@ -0,0 +1,66 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/scheduler/v1/cloudscheduler.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/cloud/scheduler/v1/job_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/scheduler/v1/cloudscheduler.proto", :syntax => :proto3) do
+    add_message "google.cloud.scheduler.v1.ListJobsRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 5
+      optional :page_token, :string, 6
+    end
+    add_message "google.cloud.scheduler.v1.ListJobsResponse" do
+      repeated :jobs, :message, 1, "google.cloud.scheduler.v1.Job"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.scheduler.v1.GetJobRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.scheduler.v1.CreateJobRequest" do
+      optional :parent, :string, 1
+      optional :job, :message, 2, "google.cloud.scheduler.v1.Job"
+    end
+    add_message "google.cloud.scheduler.v1.UpdateJobRequest" do
+      optional :job, :message, 1, "google.cloud.scheduler.v1.Job"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "google.cloud.scheduler.v1.DeleteJobRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.scheduler.v1.PauseJobRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.scheduler.v1.ResumeJobRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.scheduler.v1.RunJobRequest" do
+      optional :name, :string, 1
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Scheduler
+      module V1
+        ListJobsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.ListJobsRequest").msgclass
+        ListJobsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.ListJobsResponse").msgclass
+        GetJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.GetJobRequest").msgclass
+        CreateJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.CreateJobRequest").msgclass
+        UpdateJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.UpdateJobRequest").msgclass
+        DeleteJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.DeleteJobRequest").msgclass
+        PauseJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.PauseJobRequest").msgclass
+        ResumeJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.ResumeJobRequest").msgclass
+        RunJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.RunJobRequest").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/scheduler/v1/cloudscheduler_services_pb.rb

@@ -0,0 +1,83 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/scheduler/v1/cloudscheduler.proto for package 'google.cloud.scheduler.v1'
+# Original file comments:
+# Copyright 2019 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
+#
+#     http://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.
+#
+#
+
+require 'grpc'
+require 'google/cloud/scheduler/v1/cloudscheduler_pb'
+
+module Google
+  module Cloud
+    module Scheduler
+      module V1
+        module CloudScheduler
+          # The Cloud Scheduler API allows external entities to reliably
+          # schedule asynchronous jobs.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.scheduler.v1.CloudScheduler'
+
+            # Lists jobs.
+            rpc :ListJobs, ListJobsRequest, ListJobsResponse
+            # Gets a job.
+            rpc :GetJob, GetJobRequest, Job
+            # Creates a job.
+            rpc :CreateJob, CreateJobRequest, Job
+            # Updates a job.
+            #
+            # If successful, the updated [Job][google.cloud.scheduler.v1.Job] is returned. If the job does
+            # not exist, `NOT_FOUND` is returned.
+            #
+            # If UpdateJob does not successfully return, it is possible for the
+            # job to be in an [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1.Job.State.UPDATE_FAILED] state. A job in this state may
+            # not be executed. If this happens, retry the UpdateJob request
+            # until a successful response is received.
+            rpc :UpdateJob, UpdateJobRequest, Job
+            # Deletes a job.
+            rpc :DeleteJob, DeleteJobRequest, Google::Protobuf::Empty
+            # Pauses a job.
+            #
+            # If a job is paused then the system will stop executing the job
+            # until it is re-enabled via [ResumeJob][google.cloud.scheduler.v1.CloudScheduler.ResumeJob]. The
+            # state of the job is stored in [state][google.cloud.scheduler.v1.Job.state]; if paused it
+            # will be set to [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. A job must be in [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]
+            # to be paused.
+            rpc :PauseJob, PauseJobRequest, Job
+            # Resume a job.
+            #
+            # This method reenables a job after it has been [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. The
+            # state of a job is stored in [Job.state][google.cloud.scheduler.v1.Job.state]; after calling this method it
+            # will be set to [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]. A job must be in
+            # [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED] to be resumed.
+            rpc :ResumeJob, ResumeJobRequest, Job
+            # Forces a job to run now.
+            #
+            # When this method is called, Cloud Scheduler will dispatch the job, even
+            # if the job is already running.
+            rpc :RunJob, RunJobRequest, Job
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/scheduler/v1/job_pb.rb

@@ -0,0 +1,59 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/scheduler/v1/job.proto
+
+require 'google/protobuf'
+
+require 'google/api/resource_pb'
+require 'google/cloud/scheduler/v1/target_pb'
+require 'google/protobuf/duration_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/rpc/status_pb'
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/scheduler/v1/job.proto", :syntax => :proto3) do
+    add_message "google.cloud.scheduler.v1.Job" do
+      optional :name, :string, 1
+      optional :description, :string, 2
+      optional :schedule, :string, 20
+      optional :time_zone, :string, 21
+      optional :user_update_time, :message, 9, "google.protobuf.Timestamp"
+      optional :state, :enum, 10, "google.cloud.scheduler.v1.Job.State"
+      optional :status, :message, 11, "google.rpc.Status"
+      optional :schedule_time, :message, 17, "google.protobuf.Timestamp"
+      optional :last_attempt_time, :message, 18, "google.protobuf.Timestamp"
+      optional :retry_config, :message, 19, "google.cloud.scheduler.v1.RetryConfig"
+      optional :attempt_deadline, :message, 22, "google.protobuf.Duration"
+      oneof :target do
+        optional :pubsub_target, :message, 4, "google.cloud.scheduler.v1.PubsubTarget"
+        optional :app_engine_http_target, :message, 5, "google.cloud.scheduler.v1.AppEngineHttpTarget"
+        optional :http_target, :message, 6, "google.cloud.scheduler.v1.HttpTarget"
+      end
+    end
+    add_enum "google.cloud.scheduler.v1.Job.State" do
+      value :STATE_UNSPECIFIED, 0
+      value :ENABLED, 1
+      value :PAUSED, 2
+      value :DISABLED, 3
+      value :UPDATE_FAILED, 4
+    end
+    add_message "google.cloud.scheduler.v1.RetryConfig" do
+      optional :retry_count, :int32, 1
+      optional :max_retry_duration, :message, 2, "google.protobuf.Duration"
+      optional :min_backoff_duration, :message, 3, "google.protobuf.Duration"
+      optional :max_backoff_duration, :message, 4, "google.protobuf.Duration"
+      optional :max_doublings, :int32, 5
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Scheduler
+      module V1
+        Job = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.Job").msgclass
+        Job::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.Job.State").enummodule
+        RetryConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.RetryConfig").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/scheduler/v1/target_pb.rb

@@ -0,0 +1,73 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/scheduler/v1/target.proto
+
+require 'google/protobuf'
+
+require 'google/api/resource_pb'
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/scheduler/v1/target.proto", :syntax => :proto3) do
+    add_message "google.cloud.scheduler.v1.HttpTarget" do
+      optional :uri, :string, 1
+      optional :http_method, :enum, 2, "google.cloud.scheduler.v1.HttpMethod"
+      map :headers, :string, :string, 3
+      optional :body, :bytes, 4
+      oneof :authorization_header do
+        optional :oauth_token, :message, 5, "google.cloud.scheduler.v1.OAuthToken"
+        optional :oidc_token, :message, 6, "google.cloud.scheduler.v1.OidcToken"
+      end
+    end
+    add_message "google.cloud.scheduler.v1.AppEngineHttpTarget" do
+      optional :http_method, :enum, 1, "google.cloud.scheduler.v1.HttpMethod"
+      optional :app_engine_routing, :message, 2, "google.cloud.scheduler.v1.AppEngineRouting"
+      optional :relative_uri, :string, 3
+      map :headers, :string, :string, 4
+      optional :body, :bytes, 5
+    end
+    add_message "google.cloud.scheduler.v1.PubsubTarget" do
+      optional :topic_name, :string, 1
+      optional :data, :bytes, 3
+      map :attributes, :string, :string, 4
+    end
+    add_message "google.cloud.scheduler.v1.AppEngineRouting" do
+      optional :service, :string, 1
+      optional :version, :string, 2
+      optional :instance, :string, 3
+      optional :host, :string, 4
+    end
+    add_message "google.cloud.scheduler.v1.OAuthToken" do
+      optional :service_account_email, :string, 1
+      optional :scope, :string, 2
+    end
+    add_message "google.cloud.scheduler.v1.OidcToken" do
+      optional :service_account_email, :string, 1
+      optional :audience, :string, 2
+    end
+    add_enum "google.cloud.scheduler.v1.HttpMethod" do
+      value :HTTP_METHOD_UNSPECIFIED, 0
+      value :POST, 1
+      value :GET, 2
+      value :HEAD, 3
+      value :PUT, 4
+      value :DELETE, 5
+      value :PATCH, 6
+      value :OPTIONS, 7
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Scheduler
+      module V1
+        HttpTarget = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.HttpTarget").msgclass
+        AppEngineHttpTarget = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.AppEngineHttpTarget").msgclass
+        PubsubTarget = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.PubsubTarget").msgclass
+        AppEngineRouting = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.AppEngineRouting").msgclass
+        OAuthToken = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.OAuthToken").msgclass
+        OidcToken = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.OidcToken").msgclass
+        HttpMethod = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.scheduler.v1.HttpMethod").enummodule
+      end
+    end
+  end
+end

data/lib/google/cloud/scheduler/v1/version.rb

@@ -0,0 +1,28 @@
+# 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 Scheduler
+      module V1
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/lib/google/cloud/scheduler/v1.rb

@@ -0,0 +1,35 @@
+# 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!
+
+require "google/cloud/scheduler/v1/cloud_scheduler"
+require "google/cloud/scheduler/v1/version"
+
+module Google
+  module Cloud
+    module Scheduler
+      ##
+      # To load this package, including all its services, and instantiate a client:
+      #
+      #     require "google/cloud/scheduler/v1"
+      #     client = ::Google::Cloud::Scheduler::V1::CloudScheduler::Client.new
+      #
+      module V1
+      end
+    end
+  end
+end

data/lib/google-cloud-scheduler-v1.rb

@@ -0,0 +1,21 @@
+# 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!
+
+# This gem does not autoload during Bundler.require. To load this gem,
+# issue explicit require statements for the packages desired, e.g.:
+# require "google/cloud/scheduler/v1"

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Cloud Scheduler V1 Protocol Buffer Documentation
+
+These files are for the YARD documentation of the generated protobuf files.
+They are not intended to be required or loaded at runtime.

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,59 @@
+# 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
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+    end
+  end
+end