google-cloud-video_intelligence 1.1.1 → 1.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (27) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/lib/google/cloud/video_intelligence.rb +4 -4
  4. data/lib/google/cloud/video_intelligence/v1.rb +4 -4
  5. data/lib/google/cloud/video_intelligence/v1/doc/google/cloud/videointelligence/v1/video_intelligence.rb +23 -23
  6. data/lib/google/cloud/video_intelligence/v1/doc/google/longrunning/operations.rb +9 -9
  7. data/lib/google/cloud/video_intelligence/v1/doc/google/protobuf/any.rb +8 -8
  8. data/lib/google/cloud/video_intelligence/v1/doc/google/protobuf/duration.rb +3 -3
  9. data/lib/google/cloud/video_intelligence/v1/doc/google/rpc/status.rb +11 -11
  10. data/lib/google/cloud/video_intelligence/v1/video_intelligence_service_client.rb +10 -10
  11. data/lib/google/cloud/video_intelligence/v1beta1.rb +4 -4
  12. data/lib/google/cloud/video_intelligence/v1beta1/doc/google/cloud/videointelligence/v1beta1/video_intelligence.rb +21 -21
  13. data/lib/google/cloud/video_intelligence/v1beta1/doc/google/longrunning/operations.rb +9 -9
  14. data/lib/google/cloud/video_intelligence/v1beta1/doc/google/protobuf/any.rb +8 -8
  15. data/lib/google/cloud/video_intelligence/v1beta1/doc/google/rpc/status.rb +11 -11
  16. data/lib/google/cloud/video_intelligence/v1beta1/video_intelligence_service_client.rb +9 -9
  17. data/lib/google/cloud/video_intelligence/v1beta2.rb +4 -4
  18. data/lib/google/cloud/video_intelligence/v1beta2/doc/google/cloud/videointelligence/v1beta2/video_intelligence.rb +23 -23
  19. data/lib/google/cloud/video_intelligence/v1beta2/doc/google/longrunning/operations.rb +9 -9
  20. data/lib/google/cloud/video_intelligence/v1beta2/doc/google/protobuf/any.rb +8 -8
  21. data/lib/google/cloud/video_intelligence/v1beta2/doc/google/protobuf/duration.rb +3 -3
  22. data/lib/google/cloud/video_intelligence/v1beta2/doc/google/rpc/status.rb +11 -11
  23. data/lib/google/cloud/video_intelligence/v1beta2/video_intelligence_service_client.rb +10 -10
  24. metadata +3 -6
  25. data/lib/google/cloud/video_intelligence/v1/doc/overview.rb +0 -118
  26. data/lib/google/cloud/video_intelligence/v1beta1/doc/overview.rb +0 -80
  27. data/lib/google/cloud/video_intelligence/v1beta2/doc/overview.rb +0 -80
data/lib/google/cloud/video_intelligence/v1beta1.rb CHANGED
@@ -23,7 +23,7 @@ module Google
23
23
  # rubocop:disable LineLength
24
24
 
25
25
  ##
26
- # # Ruby Client for Google Cloud Video Intelligence API ([GA](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
26
+ # # Ruby Client for Google Cloud Video Intelligence API ([GA](https://github.com/googleapis/google-cloud-ruby#versioning))
27
27
  #
28
28
  # [Google Cloud Video Intelligence API][Product Documentation]:
29
29
  # Google Cloud Video Intelligence API.
@@ -36,7 +36,7 @@ module Google
36
36
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
37
37
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
38
38
  # 3. [Enable the Google Cloud Video Intelligence API.](https://console.cloud.google.com/apis/library/videointelligence.googleapis.com)
39
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
39
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
40
40
  #
41
41
  # ### Installation
42
42
  # ```
@@ -46,7 +46,7 @@ module Google
46
46
  # ### Next Steps
47
47
  # - Read the [Google Cloud Video Intelligence API Product documentation][Product Documentation]
48
48
  # to learn more about the product and see How-to Guides.
49
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
49
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
50
50
  # to see the full list of Cloud APIs that we cover.
51
51
  #
52
52
  # [Product Documentation]: https://cloud.google.com/video-intelligence
@@ -55,7 +55,7 @@ module Google
55
55
  #
56
56
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
57
57
  # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
58
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
58
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
59
59
  # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
60
60
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
61
61
  #
data/lib/google/cloud/video_intelligence/v1beta1/doc/google/cloud/videointelligence/v1beta1/video_intelligence.rb CHANGED
@@ -23,17 +23,17 @@ module Google
23
23
  # Input video location. Currently, only
24
24
  # [Google Cloud Storage](https://cloud.google.com/storage/) URIs are
25
25
  # supported, which must be specified in the following format:
26
- # +gs://bucket-id/object-id+ (other URI formats return
26
+ # `gs://bucket-id/object-id` (other URI formats return
27
27
  # {Google::Rpc::Code::INVALID_ARGUMENT}). For more information, see
28
28
  # [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
29
- # A video URI may include wildcards in +object-id+, and thus identify
29
+ # A video URI may include wildcards in `object-id`, and thus identify
30
30
  # multiple videos. Supported wildcards: '*' to match 0 or more characters;
31
31
  # '?' to match 1 character. If unset, the input video should be embedded
32
- # in the request as +input_content+. If set, +input_content+ should be unset.
32
+ # in the request as `input_content`. If set, `input_content` should be unset.
33
33
  # @!attribute [rw] input_content
34
34
  # @return [String]
35
35
  # The video data bytes. Encoding: base64. If unset, the input video(s)
36
- # should be specified via +input_uri+. If set, +input_uri+ should be unset.
36
+ # should be specified via `input_uri`. If set, `input_uri` should be unset.
37
37
  # @!attribute [rw] features
38
38
  # @return [Array<Google::Cloud::Videointelligence::V1beta1::Feature>]
39
39
  # Requested video annotation features.
@@ -45,13 +45,13 @@ module Google
45
45
  # Optional location where the output (in JSON format) should be stored.
46
46
  # Currently, only [Google Cloud Storage](https://cloud.google.com/storage/)
47
47
  # URIs are supported, which must be specified in the following format:
48
- # +gs://bucket-id/object-id+ (other URI formats return
48
+ # `gs://bucket-id/object-id` (other URI formats return
49
49
  # {Google::Rpc::Code::INVALID_ARGUMENT}). For more information, see
50
50
  # [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
51
51
  # @!attribute [rw] location_id
52
52
  # @return [String]
53
53
  # Optional cloud region where annotation should take place. Supported cloud
54
- # regions: +us-east1+, +us-west1+, +europe-west1+, +asia-east1+. If no region
54
+ # regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region
55
55
  # is specified, a region will be determined based on video file location.
56
56
  class AnnotateVideoRequest; end
57
57
 
@@ -65,7 +65,7 @@ module Google
65
65
  # @return [Google::Cloud::Videointelligence::V1beta1::LabelDetectionMode]
66
66
  # If label detection has been requested, what labels should be detected
67
67
  # in addition to video-level labels or segment-level labels. If unspecified,
68
- # defaults to +SHOT_MODE+.
68
+ # defaults to `SHOT_MODE`.
69
69
  # @!attribute [rw] stationary_camera
70
70
  # @return [true, false]
71
71
  # Whether the video has been shot from a stationary (i.e. non-moving) camera.
@@ -102,7 +102,7 @@ module Google
102
102
  # @return [Google::Cloud::Videointelligence::V1beta1::VideoSegment]
103
103
  # Video segment. Set to [-1, -1] for video-level labels.
104
104
  # Set to [timestamp, timestamp] for frame-level labels.
105
- # Otherwise, corresponds to one of +AnnotateSpec.segments+
105
+ # Otherwise, corresponds to one of `AnnotateSpec.segments`
106
106
  # (if specified) or to shot boundaries (if requested).
107
107
  # @!attribute [rw] confidence
108
108
  # @return [Float]
@@ -115,10 +115,10 @@ module Google
115
115
  # Label annotation.
116
116
  # @!attribute [rw] description
117
117
  # @return [String]
118
- # Textual description, e.g. +Fixed-gear bicycle+.
118
+ # Textual description, e.g. `Fixed-gear bicycle`.
119
119
  # @!attribute [rw] language_code
120
120
  # @return [String]
121
- # Language code for +description+ in BCP-47 format.
121
+ # Language code for `description` in BCP-47 format.
122
122
  # @!attribute [rw] locations
123
123
  # @return [Array<Google::Cloud::Videointelligence::V1beta1::LabelLocation>]
124
124
  # Where the label was detected and with what confidence.
@@ -127,7 +127,7 @@ module Google
127
127
  # Safe search annotation (based on per-frame visual signals only).
128
128
  # If no unsafe content has been detected in a frame, no annotations
129
129
  # are present for that frame. If only some types of unsafe content
130
- # have been detected in a frame, the likelihood is set to +UNKNOWN+
130
+ # have been detected in a frame, the likelihood is set to `UNKNOWN`
131
131
  # for all other types of unsafe content.
132
132
  # @!attribute [rw] adult
133
133
  # @return [Google::Cloud::Videointelligence::V1beta1::Likelihood]
@@ -207,16 +207,16 @@ module Google
207
207
  # Safe search annotations.
208
208
  # @!attribute [rw] error
209
209
  # @return [Google::Rpc::Status]
210
- # If set, indicates an error. Note that for a single +AnnotateVideoRequest+
210
+ # If set, indicates an error. Note that for a single `AnnotateVideoRequest`
211
211
  # some videos may succeed and some may fail.
212
212
  class VideoAnnotationResults; end
213
213
 
214
- # Video annotation response. Included in the +response+
215
- # field of the +Operation+ returned by the +GetOperation+
216
- # call of the +google::longrunning::Operations+ service.
214
+ # Video annotation response. Included in the `response`
215
+ # field of the `Operation` returned by the `GetOperation`
216
+ # call of the `google::longrunning::Operations` service.
217
217
  # @!attribute [rw] annotation_results
218
218
  # @return [Array<Google::Cloud::Videointelligence::V1beta1::VideoAnnotationResults>]
219
- # Annotation results for all videos specified in +AnnotateVideoRequest+.
219
+ # Annotation results for all videos specified in `AnnotateVideoRequest`.
220
220
  class AnnotateVideoResponse; end
221
221
 
222
222
  # Annotation progress for a single video.
@@ -236,12 +236,12 @@ module Google
236
236
  # Time of the most recent update.
237
237
  class VideoAnnotationProgress; end
238
238
 
239
- # Video annotation progress. Included in the +metadata+
240
- # field of the +Operation+ returned by the +GetOperation+
241
- # call of the +google::longrunning::Operations+ service.
239
+ # Video annotation progress. Included in the `metadata`
240
+ # field of the `Operation` returned by the `GetOperation`
241
+ # call of the `google::longrunning::Operations` service.
242
242
  # @!attribute [rw] annotation_progress
243
243
  # @return [Array<Google::Cloud::Videointelligence::V1beta1::VideoAnnotationProgress>]
244
- # Progress metadata for all videos specified in +AnnotateVideoRequest+.
244
+ # Progress metadata for all videos specified in `AnnotateVideoRequest`.
245
245
  class AnnotateVideoProgress; end
246
246
 
247
247
  # Video annotation feature.
@@ -270,7 +270,7 @@ module Google
270
270
  # Video-level. Corresponds to the whole video.
271
271
  VIDEO_LEVEL = 1
272
272
 
273
- # Segment-level. Corresponds to one of +AnnotateSpec.segments+.
273
+ # Segment-level. Corresponds to one of `AnnotateSpec.segments`.
274
274
  SEGMENT_LEVEL = 2
275
275
 
276
276
  # Shot-level. Corresponds to a single shot (i.e. a series of frames
data/lib/google/cloud/video_intelligence/v1beta1/doc/google/longrunning/operations.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  # @return [String]
22
22
  # The server-assigned name, which is only unique within the same service that
23
23
  # originally returns it. If you use the default HTTP mapping, the
24
- # +name+ should have the format of +operations/some/unique/name+.
24
+ # `name` should have the format of `operations/some/unique/name`.
25
25
  # @!attribute [rw] metadata
26
26
  # @return [Google::Protobuf::Any]
27
27
  # Service-specific metadata associated with the operation. It typically
@@ -30,8 +30,8 @@ module Google
30
30
  # long-running operation should document the metadata type, if any.
31
31
  # @!attribute [rw] done
32
32
  # @return [true, false]
33
- # If the value is +false+, it means the operation is still in progress.
34
- # If true, the operation is completed, and either +error+ or +response+ is
33
+ # If the value is `false`, it means the operation is still in progress.
34
+ # If true, the operation is completed, and either `error` or `response` is
35
35
  # available.
36
36
  # @!attribute [rw] error
37
37
  # @return [Google::Rpc::Status]
@@ -39,13 +39,13 @@ module Google
39
39
  # @!attribute [rw] response
40
40
  # @return [Google::Protobuf::Any]
41
41
  # The normal response of the operation in case of success. If the original
42
- # method returns no data on success, such as +Delete+, the response is
43
- # +google.protobuf.Empty+. If the original method is standard
44
- # +Get+/+Create+/+Update+, the response should be the resource. For other
45
- # methods, the response should have the type +XxxResponse+, where +Xxx+
42
+ # method returns no data on success, such as `Delete`, the response is
43
+ # `google.protobuf.Empty`. If the original method is standard
44
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
45
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
46
46
  # is the original method name. For example, if the original method name
47
- # is +TakeSnapshot()+, the inferred response type is
48
- # +TakeSnapshotResponse+.
47
+ # is `TakeSnapshot()`, the inferred response type is
48
+ # `TakeSnapshotResponse`.
49
49
  class Operation; end
50
50
 
51
51
  # The request message for {Google::Longrunning::Operations::GetOperation Operations::GetOperation}.
data/lib/google/cloud/video_intelligence/v1beta1/doc/google/protobuf/any.rb CHANGED
@@ -15,7 +15,7 @@
15
15
 
16
16
  module Google
17
17
  module Protobuf
18
- # +Any+ contains an arbitrary serialized protocol buffer message along with a
18
+ # `Any` contains an arbitrary serialized protocol buffer message along with a
19
19
  # URL that describes the type of the serialized message.
20
20
  #
21
21
  # Protobuf library provides support to pack/unpack Any values in the form
@@ -69,9 +69,9 @@ module Google
69
69
  #
70
70
  # = JSON
71
71
  #
72
- # The JSON representation of an +Any+ value uses the regular
72
+ # The JSON representation of an `Any` value uses the regular
73
73
  # representation of the deserialized, embedded message, with an
74
- # additional field +@type+ which contains the type URL. Example:
74
+ # additional field `@type` which contains the type URL. Example:
75
75
  #
76
76
  # package google.profile;
77
77
  # message Person {
@@ -87,7 +87,7 @@ module Google
87
87
  #
88
88
  # If the embedded message type is well-known and has a custom JSON
89
89
  # representation, that representation will be embedded adding a field
90
- # +value+ which holds the custom JSON in addition to the +@type+
90
+ # `value` which holds the custom JSON in addition to the `@type`
91
91
  # field. Example (for message {Google::Protobuf::Duration}):
92
92
  #
93
93
  # {
@@ -99,15 +99,15 @@ module Google
99
99
  # A URL/resource name that uniquely identifies the type of the serialized
100
100
  # protocol buffer message. The last segment of the URL's path must represent
101
101
  # the fully qualified name of the type (as in
102
- # +path/google.protobuf.Duration+). The name should be in a canonical form
102
+ # `path/google.protobuf.Duration`). The name should be in a canonical form
103
103
  # (e.g., leading "." is not accepted).
104
104
  #
105
105
  # In practice, teams usually precompile into the binary all types that they
106
106
  # expect it to use in the context of Any. However, for URLs which use the
107
- # scheme +http+, +https+, or no scheme, one can optionally set up a type
107
+ # scheme `http`, `https`, or no scheme, one can optionally set up a type
108
108
  # server that maps type URLs to message definitions as follows:
109
109
  #
110
- # * If no scheme is provided, +https+ is assumed.
110
+ # * If no scheme is provided, `https` is assumed.
111
111
  # * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
112
112
  # value in binary format, or produce an error.
113
113
  # * Applications are allowed to cache lookup results based on the
@@ -120,7 +120,7 @@ module Google
120
120
  # protobuf release, and it is not used for type URLs beginning with
121
121
  # type.googleapis.com.
122
122
  #
123
- # Schemes other than +http+, +https+ (or the empty scheme) might be
123
+ # Schemes other than `http`, `https` (or the empty scheme) might be
124
124
  # used with implementation specific semantics.
125
125
  # @!attribute [rw] value
126
126
  # @return [String]
data/lib/google/cloud/video_intelligence/v1beta1/doc/google/rpc/status.rb CHANGED
@@ -15,7 +15,7 @@
15
15
 
16
16
  module Google
17
17
  module Rpc
18
- # The +Status+ type defines a logical error model that is suitable for different
18
+ # The `Status` type defines a logical error model that is suitable for different
19
19
  # programming environments, including REST APIs and RPC APIs. It is used by
20
20
  # [gRPC](https://github.com/grpc). The error model is designed to be:
21
21
  #
@@ -24,7 +24,7 @@ module Google
24
24
  #
25
25
  # = Overview
26
26
  #
27
- # The +Status+ message contains three pieces of data: error code, error message,
27
+ # The `Status` message contains three pieces of data: error code, error message,
28
28
  # and error details. The error code should be an enum value of
29
29
  # {Google::Rpc::Code}, but it may accept additional error codes if needed. The
30
30
  # error message should be a developer-facing English message that helps
@@ -32,40 +32,40 @@ module Google
32
32
  # error message is needed, put the localized message in the error details or
33
33
  # localize it in the client. The optional error details may contain arbitrary
34
34
  # information about the error. There is a predefined set of error detail types
35
- # in the package +google.rpc+ that can be used for common error conditions.
35
+ # in the package `google.rpc` that can be used for common error conditions.
36
36
  #
37
37
  # = Language mapping
38
38
  #
39
- # The +Status+ message is the logical representation of the error model, but it
40
- # is not necessarily the actual wire format. When the +Status+ message is
39
+ # The `Status` message is the logical representation of the error model, but it
40
+ # is not necessarily the actual wire format. When the `Status` message is
41
41
  # exposed in different client libraries and different wire protocols, it can be
42
42
  # mapped differently. For example, it will likely be mapped to some exceptions
43
43
  # in Java, but more likely mapped to some error codes in C.
44
44
  #
45
45
  # = Other uses
46
46
  #
47
- # The error model and the +Status+ message can be used in a variety of
47
+ # The error model and the `Status` message can be used in a variety of
48
48
  # environments, either with or without APIs, to provide a
49
49
  # consistent developer experience across different environments.
50
50
  #
51
51
  # Example uses of this error model include:
52
52
  #
53
53
  # * Partial errors. If a service needs to return partial errors to the client,
54
- # it may embed the +Status+ in the normal response to indicate the partial
54
+ # it may embed the `Status` in the normal response to indicate the partial
55
55
  # errors.
56
56
  #
57
57
  # * Workflow errors. A typical workflow has multiple steps. Each step may
58
- # have a +Status+ message for error reporting.
58
+ # have a `Status` message for error reporting.
59
59
  #
60
60
  # * Batch operations. If a client uses batch request and batch response, the
61
- # +Status+ message should be used directly inside batch response, one for
61
+ # `Status` message should be used directly inside batch response, one for
62
62
  # each error sub-response.
63
63
  #
64
64
  # * Asynchronous operations. If an API call embeds asynchronous operation
65
65
  # results in its response, the status of those operations should be
66
- # represented directly using the +Status+ message.
66
+ # represented directly using the `Status` message.
67
67
  #
68
- # * Logging. If some API errors are stored in logs, the message +Status+ could
68
+ # * Logging. If some API errors are stored in logs, the message `Status` could
69
69
  # be used directly after any stripping needed for security/privacy reasons.
70
70
  # @!attribute [rw] code
71
71
  # @return [Integer]
data/lib/google/cloud/video_intelligence/v1beta1/video_intelligence_service_client.rb CHANGED
@@ -186,26 +186,26 @@ module Google
186
186
  # Service calls
187
187
 
188
188
  # Performs asynchronous video annotation. Progress and results can be
189
- # retrieved through the +google.longrunning.Operations+ interface.
190
- # +Operation.metadata+ contains +AnnotateVideoProgress+ (progress).
191
- # +Operation.response+ contains +AnnotateVideoResponse+ (results).
189
+ # retrieved through the `google.longrunning.Operations` interface.
190
+ # `Operation.metadata` contains `AnnotateVideoProgress` (progress).
191
+ # `Operation.response` contains `AnnotateVideoResponse` (results).
192
192
  #
193
193
  # @param input_uri [String]
194
194
  # Input video location. Currently, only
195
195
  # [Google Cloud Storage](https://cloud.google.com/storage/) URIs are
196
196
  # supported, which must be specified in the following format:
197
- # +gs://bucket-id/object-id+ (other URI formats return
197
+ # `gs://bucket-id/object-id` (other URI formats return
198
198
  # {Google::Rpc::Code::INVALID_ARGUMENT}). For more information, see
199
199
  # [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
200
- # A video URI may include wildcards in +object-id+, and thus identify
200
+ # A video URI may include wildcards in `object-id`, and thus identify
201
201
  # multiple videos. Supported wildcards: '*' to match 0 or more characters;
202
202
  # '?' to match 1 character. If unset, the input video should be embedded
203
- # in the request as +input_content+. If set, +input_content+ should be unset.
203
+ # in the request as `input_content`. If set, `input_content` should be unset.
204
204
  # @param features [Array<Google::Cloud::Videointelligence::V1beta1::Feature>]
205
205
  # Requested video annotation features.
206
206
  # @param input_content [String]
207
207
  # The video data bytes. Encoding: base64. If unset, the input video(s)
208
- # should be specified via +input_uri+. If set, +input_uri+ should be unset.
208
+ # should be specified via `input_uri`. If set, `input_uri` should be unset.
209
209
  # @param video_context [Google::Cloud::Videointelligence::V1beta1::VideoContext | Hash]
210
210
  # Additional video context and/or feature-specific parameters.
211
211
  # A hash of the same form as `Google::Cloud::Videointelligence::V1beta1::VideoContext`
@@ -214,12 +214,12 @@ module Google
214
214
  # Optional location where the output (in JSON format) should be stored.
215
215
  # Currently, only [Google Cloud Storage](https://cloud.google.com/storage/)
216
216
  # URIs are supported, which must be specified in the following format:
217
- # +gs://bucket-id/object-id+ (other URI formats return
217
+ # `gs://bucket-id/object-id` (other URI formats return
218
218
  # {Google::Rpc::Code::INVALID_ARGUMENT}). For more information, see
219
219
  # [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
220
220
  # @param location_id [String]
221
221
  # Optional cloud region where annotation should take place. Supported cloud
222
- # regions: +us-east1+, +us-west1+, +europe-west1+, +asia-east1+. If no region
222
+ # regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region
223
223
  # is specified, a region will be determined based on video file location.
224
224
  # @param options [Google::Gax::CallOptions]
225
225
  # Overrides the default settings for this call, e.g, timeout,
data/lib/google/cloud/video_intelligence/v1beta2.rb CHANGED
@@ -23,7 +23,7 @@ module Google
23
23
  # rubocop:disable LineLength
24
24
 
25
25
  ##
26
- # # Ruby Client for Google Cloud Video Intelligence API ([GA](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
26
+ # # Ruby Client for Google Cloud Video Intelligence API ([GA](https://github.com/googleapis/google-cloud-ruby#versioning))
27
27
  #
28
28
  # [Google Cloud Video Intelligence API][Product Documentation]:
29
29
  # Google Cloud Video Intelligence API.
@@ -36,7 +36,7 @@ module Google
36
36
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
37
37
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
38
38
  # 3. [Enable the Google Cloud Video Intelligence API.](https://console.cloud.google.com/apis/library/videointelligence.googleapis.com)
39
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
39
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
40
40
  #
41
41
  # ### Installation
42
42
  # ```
@@ -46,7 +46,7 @@ module Google
46
46
  # ### Next Steps
47
47
  # - Read the [Google Cloud Video Intelligence API Product documentation][Product Documentation]
48
48
  # to learn more about the product and see How-to Guides.
49
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
49
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
50
50
  # to see the full list of Cloud APIs that we cover.
51
51
  #
52
52
  # [Product Documentation]: https://cloud.google.com/video-intelligence
@@ -55,7 +55,7 @@ module Google
55
55
  #
56
56
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
57
57
  # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
58
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
58
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
59
59
  # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
60
60
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
61
61
  #
data/lib/google/cloud/video_intelligence/v1beta2/doc/google/cloud/videointelligence/v1beta2/video_intelligence.rb CHANGED
@@ -23,18 +23,18 @@ module Google
23
23
  # Input video location. Currently, only
24
24
  # [Google Cloud Storage](https://cloud.google.com/storage/) URIs are
25
25
  # supported, which must be specified in the following format:
26
- # +gs://bucket-id/object-id+ (other URI formats return
26
+ # `gs://bucket-id/object-id` (other URI formats return
27
27
  # {Google::Rpc::Code::INVALID_ARGUMENT}). For more information, see
28
28
  # [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
29
- # A video URI may include wildcards in +object-id+, and thus identify
29
+ # A video URI may include wildcards in `object-id`, and thus identify
30
30
  # multiple videos. Supported wildcards: '*' to match 0 or more characters;
31
31
  # '?' to match 1 character. If unset, the input video should be embedded
32
- # in the request as +input_content+. If set, +input_content+ should be unset.
32
+ # in the request as `input_content`. If set, `input_content` should be unset.
33
33
  # @!attribute [rw] input_content
34
34
  # @return [String]
35
35
  # The video data bytes.
36
- # If unset, the input video(s) should be specified via +input_uri+.
37
- # If set, +input_uri+ should be unset.
36
+ # If unset, the input video(s) should be specified via `input_uri`.
37
+ # If set, `input_uri` should be unset.
38
38
  # @!attribute [rw] features
39
39
  # @return [Array<Google::Cloud::Videointelligence::V1beta2::Feature>]
40
40
  # Requested video annotation features.
@@ -46,13 +46,13 @@ module Google
46
46
  # Optional location where the output (in JSON format) should be stored.
47
47
  # Currently, only [Google Cloud Storage](https://cloud.google.com/storage/)
48
48
  # URIs are supported, which must be specified in the following format:
49
- # +gs://bucket-id/object-id+ (other URI formats return
49
+ # `gs://bucket-id/object-id` (other URI formats return
50
50
  # {Google::Rpc::Code::INVALID_ARGUMENT}). For more information, see
51
51
  # [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
52
52
  # @!attribute [rw] location_id
53
53
  # @return [String]
54
54
  # Optional cloud region where annotation should take place. Supported cloud
55
- # regions: +us-east1+, +us-west1+, +europe-west1+, +asia-east1+. If no region
55
+ # regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region
56
56
  # is specified, a region will be determined based on video file location.
57
57
  class AnnotateVideoRequest; end
58
58
 
@@ -81,12 +81,12 @@ module Google
81
81
  # @return [Google::Cloud::Videointelligence::V1beta2::LabelDetectionMode]
82
82
  # What labels should be detected with LABEL_DETECTION, in addition to
83
83
  # video-level labels or segment-level labels.
84
- # If unspecified, defaults to +SHOT_MODE+.
84
+ # If unspecified, defaults to `SHOT_MODE`.
85
85
  # @!attribute [rw] stationary_camera
86
86
  # @return [true, false]
87
87
  # Whether the video has been shot from a stationary (i.e. non-moving) camera.
88
88
  # When set to true, might improve detection accuracy for moving objects.
89
- # Should be used with +SHOT_AND_FRAME_MODE+ enabled.
89
+ # Should be used with `SHOT_AND_FRAME_MODE` enabled.
90
90
  # @!attribute [rw] model
91
91
  # @return [String]
92
92
  # Model to use for label detection.
@@ -159,10 +159,10 @@ module Google
159
159
  # API](https://developers.google.com/knowledge-graph/).
160
160
  # @!attribute [rw] description
161
161
  # @return [String]
162
- # Textual description, e.g. +Fixed-gear bicycle+.
162
+ # Textual description, e.g. `Fixed-gear bicycle`.
163
163
  # @!attribute [rw] language_code
164
164
  # @return [String]
165
- # Language code for +description+ in BCP-47 format.
165
+ # Language code for `description` in BCP-47 format.
166
166
  class Entity; end
167
167
 
168
168
  # Label annotation.
@@ -172,9 +172,9 @@ module Google
172
172
  # @!attribute [rw] category_entities
173
173
  # @return [Array<Google::Cloud::Videointelligence::V1beta2::Entity>]
174
174
  # Common categories for the detected entity.
175
- # E.g. when the label is +Terrier+ the category is likely +dog+. And in some
176
- # cases there might be more than one categories e.g. +Terrier+ could also be
177
- # a +pet+.
175
+ # E.g. when the label is `Terrier` the category is likely `dog`. And in some
176
+ # cases there might be more than one categories e.g. `Terrier` could also be
177
+ # a `pet`.
178
178
  # @!attribute [rw] segments
179
179
  # @return [Array<Google::Cloud::Videointelligence::V1beta2::LabelSegment>]
180
180
  # All video segments where a label was detected.
@@ -276,16 +276,16 @@ module Google
276
276
  # Explicit content annotation.
277
277
  # @!attribute [rw] error
278
278
  # @return [Google::Rpc::Status]
279
- # If set, indicates an error. Note that for a single +AnnotateVideoRequest+
279
+ # If set, indicates an error. Note that for a single `AnnotateVideoRequest`
280
280
  # some videos may succeed and some may fail.
281
281
  class VideoAnnotationResults; end
282
282
 
283
- # Video annotation response. Included in the +response+
284
- # field of the +Operation+ returned by the +GetOperation+
285
- # call of the +google::longrunning::Operations+ service.
283
+ # Video annotation response. Included in the `response`
284
+ # field of the `Operation` returned by the `GetOperation`
285
+ # call of the `google::longrunning::Operations` service.
286
286
  # @!attribute [rw] annotation_results
287
287
  # @return [Array<Google::Cloud::Videointelligence::V1beta2::VideoAnnotationResults>]
288
- # Annotation results for all videos specified in +AnnotateVideoRequest+.
288
+ # Annotation results for all videos specified in `AnnotateVideoRequest`.
289
289
  class AnnotateVideoResponse; end
290
290
 
291
291
  # Annotation progress for a single video.
@@ -305,12 +305,12 @@ module Google
305
305
  # Time of the most recent update.
306
306
  class VideoAnnotationProgress; end
307
307
 
308
- # Video annotation progress. Included in the +metadata+
309
- # field of the +Operation+ returned by the +GetOperation+
310
- # call of the +google::longrunning::Operations+ service.
308
+ # Video annotation progress. Included in the `metadata`
309
+ # field of the `Operation` returned by the `GetOperation`
310
+ # call of the `google::longrunning::Operations` service.
311
311
  # @!attribute [rw] annotation_progress
312
312
  # @return [Array<Google::Cloud::Videointelligence::V1beta2::VideoAnnotationProgress>]
313
- # Progress metadata for all videos specified in +AnnotateVideoRequest+.
313
+ # Progress metadata for all videos specified in `AnnotateVideoRequest`.
314
314
  class AnnotateVideoProgress; end
315
315
 
316
316
  # Video annotation feature.