google-cloud-dataflow-v1beta3 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcb7731162e0f5363dd982bfcb51c88f9d31a399036826ba621db8aa4cc9023a
-  data.tar.gz: ce115de59d9ccd68a231c007455c57d6ebc37332cca3bfd994d1bbf530ca28a7
+  metadata.gz: fd9fbf2c0d3ea09552666fc75eeae3ed0cd65a3b3a6b1e16eb8cfb72980ea5d2
+  data.tar.gz: e07c10fb9cfc0701aa9243b5d74ca09afd9d9baec84f1b1a77cf5803b5331d45
 SHA512:
-  metadata.gz: 3f108ecd6f6e056e450175d6f51469643546ef48601b6414e3d3d8e378b7492afb89361b9f7fb205277ac5fc90af3303d35e59b01e9a5ae298589c4ae59a4fd3
-  data.tar.gz: 61e11a895f993210cb03773b4696a0b0c30d02bd76d6e0e850437ed979168ab905ea840031db9218cc51e425acf5fe36affe72f34e02ee9e734dc15234ab4f3b
+  metadata.gz: 66a2b824bab08fe7abfc52705cea98e2de483536a2e9400c97966c98f7f931e39ae3580da1206f1f0bc1768489354539d3524bd30620638b7127d97e2889ed8b
+  data.tar.gz: 9d4a12c474f3bac4a5e55a0ac19df5d8c5502c119769fc962c77d39386a1c0c9afd4160796e91847a100acda9e8e1bf9e78e83a179c7476eeebc0adcb0157bad

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Dataflow V1beta3 API
+--title="Dataflow V1beta3 API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-dataflow-v1beta3
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::Dataflow::V1beta3::Snapshots::Credentials}):
 
-1. `DATAFLOW_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `DATAFLOW_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `DATAFLOW_CREDENTIALS` - Path to JSON file, or JSON contents
+* `DATAFLOW_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/dataflow/v1beta3"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Dataflow::V1beta3::Snapshots::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/dataflow/v1beta3"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Dataflow::V1beta3::Snapshots::Client.new do |config|
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/dataflow/v1beta3"
@@ -120,15 +120,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
 [Google Cloud Platform environments](#google-cloud-platform-environments), you
 need a Google Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 2. Create a new project or click on an existing project.
-3. Activate the slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
    If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/dataflow/v1beta3"
 
 client = ::Google::Cloud::Dataflow::V1beta3::Snapshots::Client.new
-request = my_create_request
+request = ::Google::Cloud::Dataflow::V1beta3::GetSnapshotRequest.new # (request fields as keyword arguments...)
 response = client.get_snapshot request
 ```
 

data/lib/google/cloud/dataflow/v1beta3/flex_templates_service/client.rb

@@ -39,13 +39,12 @@ module Google
             # See {::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all FlexTemplatesService clients:
-            #
-            #     ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all FlexTemplatesService clients
+            #   ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -92,19 +91,15 @@ module Google
             ##
             # Create a new FlexTemplatesService client object.
             #
-            # ## Examples
-            #
-            # To create a new FlexTemplatesService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.new
             #
-            # To create a new FlexTemplatesService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the FlexTemplatesService client.
             # @yieldparam config [Client::Configuration]
@@ -124,14 +119,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -186,6 +180,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataflow/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::LaunchFlexTemplateRequest.new
+            #
+            #   # Call the launch_flex_template method.
+            #   result = client.launch_flex_template request
+            #
+            #   # The returned object is of type Google::Cloud::Dataflow::V1beta3::LaunchFlexTemplateResponse.
+            #   p result
+            #
             def launch_flex_template request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -206,7 +215,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.launch_flex_template.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.launch_flex_template.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @flex_templates_service_stub.call_rpc :launch_flex_template, request, options: options do |response, operation|
@@ -230,22 +241,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for launch_flex_template
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.launch_flex_template.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.launch_flex_template.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # launch_flex_template to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.launch_flex_template.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.launch_flex_template.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/dataflow/v1beta3/jobs/client.rb

@@ -40,13 +40,12 @@ module Google
             # See {::Google::Cloud::Dataflow::V1beta3::Jobs::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all Jobs clients:
-            #
-            #     ::Google::Cloud::Dataflow::V1beta3::Jobs::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all Jobs clients
+            #   ::Google::Cloud::Dataflow::V1beta3::Jobs::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -95,19 +94,15 @@ module Google
             ##
             # Create a new Jobs client object.
             #
-            # ## Examples
-            #
-            # To create a new Jobs client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::Jobs::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Dataflow::V1beta3::Jobs::Client.new
             #
-            # To create a new Jobs client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::Jobs::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Dataflow::V1beta3::Jobs::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Jobs client.
             # @yieldparam config [Client::Configuration]
@@ -127,14 +122,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -196,6 +190,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataflow/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataflow::V1beta3::Jobs::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::CreateJobRequest.new
+            #
+            #   # Call the create_job method.
+            #   result = client.create_job request
+            #
+            #   # The returned object is of type Google::Cloud::Dataflow::V1beta3::Job.
+            #   p result
+            #
             def create_job request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -216,7 +225,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.create_job.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_job.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @jobs_stub.call_rpc :create_job, request, options: options do |response, operation|
@@ -270,6 +281,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataflow/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataflow::V1beta3::Jobs::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::GetJobRequest.new
+            #
+            #   # Call the get_job method.
+            #   result = client.get_job request
+            #
+            #   # The returned object is of type Google::Cloud::Dataflow::V1beta3::Job.
+            #   p result
+            #
             def get_job request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -290,7 +316,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_job.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_job.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @jobs_stub.call_rpc :get_job, request, options: options do |response, operation|
@@ -345,6 +373,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataflow/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataflow::V1beta3::Jobs::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::UpdateJobRequest.new
+            #
+            #   # Call the update_job method.
+            #   result = client.update_job request
+            #
+            #   # The returned object is of type Google::Cloud::Dataflow::V1beta3::Job.
+            #   p result
+            #
             def update_job request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -365,7 +408,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.update_job.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_job.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @jobs_stub.call_rpc :update_job, request, options: options do |response, operation|
@@ -428,6 +473,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataflow/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataflow::V1beta3::Jobs::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::ListJobsRequest.new
+            #
+            #   # Call the list_jobs method.
+            #   result = client.list_jobs request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Dataflow::V1beta3::Job.
+            #     p response
+            #   end
+            #
             def list_jobs request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -448,7 +514,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_jobs.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_jobs.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @jobs_stub.call_rpc :list_jobs, request, options: options do |response, operation|
@@ -505,6 +573,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataflow/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataflow::V1beta3::Jobs::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::ListJobsRequest.new
+            #
+            #   # Call the aggregated_list_jobs method.
+            #   result = client.aggregated_list_jobs request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Dataflow::V1beta3::Job.
+            #     p response
+            #   end
+            #
             def aggregated_list_jobs request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -525,7 +614,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.aggregated_list_jobs.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.aggregated_list_jobs.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @jobs_stub.call_rpc :aggregated_list_jobs, request, options: options do |response, operation|
@@ -566,6 +657,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataflow/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataflow::V1beta3::Jobs::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::CheckActiveJobsRequest.new
+            #
+            #   # Call the check_active_jobs method.
+            #   result = client.check_active_jobs request
+            #
+            #   # The returned object is of type Google::Cloud::Dataflow::V1beta3::CheckActiveJobsResponse.
+            #   p result
+            #
             def check_active_jobs request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -586,7 +692,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.check_active_jobs.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.check_active_jobs.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @jobs_stub.call_rpc :check_active_jobs, request, options: options do |response, operation|
@@ -636,6 +744,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataflow/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataflow::V1beta3::Jobs::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::SnapshotJobRequest.new
+            #
+            #   # Call the snapshot_job method.
+            #   result = client.snapshot_job request
+            #
+            #   # The returned object is of type Google::Cloud::Dataflow::V1beta3::Snapshot.
+            #   p result
+            #
             def snapshot_job request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -656,7 +779,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.snapshot_job.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.snapshot_job.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @jobs_stub.call_rpc :snapshot_job, request, options: options do |response, operation|
@@ -680,22 +805,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for create_job
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Dataflow::V1beta3::Jobs::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.create_job.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::Jobs::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.create_job.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # create_job to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Dataflow::V1beta3::Jobs::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.create_job.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Dataflow::V1beta3::Jobs::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.create_job.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.