Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1037)

Unified Diff: generated/googleapis_beta/lib/videointelligence/v1beta1.dart

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: generated/googleapis_beta/lib/videointelligence/v1beta1.dart
diff --git a/generated/googleapis_beta/lib/videointelligence/v1beta1.dart b/generated/googleapis_beta/lib/videointelligence/v1beta1.dart
index 99159262ccd0e4a8db8366b8a6d3ad48e8626666..87b6bf923f06ff2f871ef48396406e5ad4ea9a5b 100644
--- a/generated/googleapis_beta/lib/videointelligence/v1beta1.dart
+++ b/generated/googleapis_beta/lib/videointelligence/v1beta1.dart
@@ -9,51 +9,51 @@ import 'dart:convert' as convert;
import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;
-export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show
- ApiRequestError, DetailedApiRequestError;
+export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
+ show ApiRequestError, DetailedApiRequestError;
const core.String USER_AGENT = 'dart-api-client videointelligence/v1beta1';
-/** Google Cloud Video Intelligence API. */
+/// Google Cloud Video Intelligence API.
class VideointelligenceApi {
- /** View and manage your data across Google Cloud Platform services */
- static const CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform";
-
+ /// View and manage your data across Google Cloud Platform services
+ static const CloudPlatformScope =
+ "https://www.googleapis.com/auth/cloud-platform";
final commons.ApiRequester _requester;
VideosResourceApi get videos => new VideosResourceApi(_requester);
- VideointelligenceApi(http.Client client, {core.String rootUrl: "https://videointelligence.googleapis.com/", core.String servicePath: ""}) :
- _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
+ VideointelligenceApi(http.Client client,
+ {core.String rootUrl: "https://videointelligence.googleapis.com/",
+ core.String servicePath: ""})
+ : _requester =
+ new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
}
-
class VideosResourceApi {
final commons.ApiRequester _requester;
- VideosResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Performs asynchronous video annotation. Progress and results can be
- * retrieved through the `google.longrunning.Operations` interface.
- * `Operation.metadata` contains `AnnotateVideoProgress` (progress).
- * `Operation.response` contains `AnnotateVideoResponse` (results).
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * Completes with a [GoogleLongrunningOperation].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<GoogleLongrunningOperation> annotate(GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest request) {
+ VideosResourceApi(commons.ApiRequester client) : _requester = client;
+
+ /// Performs asynchronous video annotation. Progress and results can be
+ /// retrieved through the `google.longrunning.Operations` interface.
+ /// `Operation.metadata` contains `AnnotateVideoProgress` (progress).
+ /// `Operation.response` contains `AnnotateVideoResponse` (results).
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// Completes with a [GoogleLongrunningOperation].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<GoogleLongrunningOperation> annotate(
+ GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest request) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -67,79 +67,88 @@ class VideosResourceApi {
_url = 'v1beta1/videos:annotate';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
- return _response.then((data) => new GoogleLongrunningOperation.fromJson(data));
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
+ return _response
+ .then((data) => new GoogleLongrunningOperation.fromJson(data));
}
-
}
-
-
-/**
- * Video annotation progress. Included in the `metadata`
- * field of the `Operation` returned by the `GetOperation`
- * call of the `google::longrunning::Operations` service.
- */
+/// Video annotation progress. Included in the `metadata`
+/// field of the `Operation` returned by the `GetOperation`
+/// call of the `google::longrunning::Operations` service.
class GoogleCloudVideointelligenceV1AnnotateVideoProgress {
- /** Progress metadata for all videos specified in `AnnotateVideoRequest`. */
- core.List<GoogleCloudVideointelligenceV1VideoAnnotationProgress> annotationProgress;
+ /// Progress metadata for all videos specified in `AnnotateVideoRequest`.
+ core.List<GoogleCloudVideointelligenceV1VideoAnnotationProgress>
+ annotationProgress;
GoogleCloudVideointelligenceV1AnnotateVideoProgress();
GoogleCloudVideointelligenceV1AnnotateVideoProgress.fromJson(core.Map _json) {
if (_json.containsKey("annotationProgress")) {
- annotationProgress = _json["annotationProgress"].map((value) => new GoogleCloudVideointelligenceV1VideoAnnotationProgress.fromJson(value)).toList();
+ annotationProgress = _json["annotationProgress"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1VideoAnnotationProgress
+ .fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (annotationProgress != null) {
- _json["annotationProgress"] = annotationProgress.map((value) => (value).toJson()).toList();
+ _json["annotationProgress"] =
+ annotationProgress.map((value) => (value).toJson()).toList();
}
return _json;
}
}
-/**
- * Video annotation response. Included in the `response`
- * field of the `Operation` returned by the `GetOperation`
- * call of the `google::longrunning::Operations` service.
- */
+/// Video annotation response. Included in the `response`
+/// field of the `Operation` returned by the `GetOperation`
+/// call of the `google::longrunning::Operations` service.
class GoogleCloudVideointelligenceV1AnnotateVideoResponse {
- /** Annotation results for all videos specified in `AnnotateVideoRequest`. */
- core.List<GoogleCloudVideointelligenceV1VideoAnnotationResults> annotationResults;
+ /// Annotation results for all videos specified in `AnnotateVideoRequest`.
+ core.List<GoogleCloudVideointelligenceV1VideoAnnotationResults>
+ annotationResults;
GoogleCloudVideointelligenceV1AnnotateVideoResponse();
GoogleCloudVideointelligenceV1AnnotateVideoResponse.fromJson(core.Map _json) {
if (_json.containsKey("annotationResults")) {
- annotationResults = _json["annotationResults"].map((value) => new GoogleCloudVideointelligenceV1VideoAnnotationResults.fromJson(value)).toList();
+ annotationResults = _json["annotationResults"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1VideoAnnotationResults.fromJson(
+ value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (annotationResults != null) {
- _json["annotationResults"] = annotationResults.map((value) => (value).toJson()).toList();
+ _json["annotationResults"] =
+ annotationResults.map((value) => (value).toJson()).toList();
}
return _json;
}
}
-/** Label annotation. */
+/// Label annotation.
class GoogleCloudVideointelligenceV1LabelAnnotation {
- /** Textual description, e.g. `Fixed-gear bicycle`. */
+ /// Textual description, e.g. `Fixed-gear bicycle`.
core.String description;
- /** Language code for `description` in BCP-47 format. */
+
+ /// Language code for `description` in BCP-47 format.
core.String languageCode;
- /** Where the label was detected and with what confidence. */
+
+ /// Where the label was detected and with what confidence.
core.List<GoogleCloudVideointelligenceV1LabelLocation> locations;
GoogleCloudVideointelligenceV1LabelAnnotation();
@@ -152,12 +161,16 @@ class GoogleCloudVideointelligenceV1LabelAnnotation {
languageCode = _json["languageCode"];
}
if (_json.containsKey("locations")) {
- locations = _json["locations"].map((value) => new GoogleCloudVideointelligenceV1LabelLocation.fromJson(value)).toList();
+ locations = _json["locations"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1LabelLocation.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (description != null) {
_json["description"] = description;
}
@@ -171,29 +184,27 @@ class GoogleCloudVideointelligenceV1LabelAnnotation {
}
}
-/** Label location. */
+/// Label location.
class GoogleCloudVideointelligenceV1LabelLocation {
- /** Confidence that the label is accurate. Range: [0, 1]. */
+ /// Confidence that the label is accurate. Range: [0, 1].
core.double confidence;
- /**
- * Label level.
- * Possible string values are:
- * - "LABEL_LEVEL_UNSPECIFIED" : Unspecified.
- * - "VIDEO_LEVEL" : Video-level. Corresponds to the whole video.
- * - "SEGMENT_LEVEL" : Segment-level. Corresponds to one of
- * `AnnotateSpec.segments`.
- * - "SHOT_LEVEL" : Shot-level. Corresponds to a single shot (i.e. a series of
- * frames
- * without a major camera position or background change).
- * - "FRAME_LEVEL" : Frame-level. Corresponds to a single video frame.
- */
+
+ /// Label level.
+ /// Possible string values are:
+ /// - "LABEL_LEVEL_UNSPECIFIED" : Unspecified.
+ /// - "VIDEO_LEVEL" : Video-level. Corresponds to the whole video.
+ /// - "SEGMENT_LEVEL" : Segment-level. Corresponds to one of
+ /// `AnnotateSpec.segments`.
+ /// - "SHOT_LEVEL" : Shot-level. Corresponds to a single shot (i.e. a series
+ /// of frames
+ /// without a major camera position or background change).
+ /// - "FRAME_LEVEL" : Frame-level. Corresponds to a single video frame.
core.String level;
- /**
- * Video segment. Unset for video-level labels.
- * Set to a frame timestamp for frame-level labels.
- * Otherwise, corresponds to one of `AnnotateSpec.segments`
- * (if specified) or to shot boundaries (if requested).
- */
+
+ /// Video segment. Unset for video-level labels.
+ /// Set to a frame timestamp for frame-level labels.
+ /// Otherwise, corresponds to one of `AnnotateSpec.segments`
+ /// (if specified) or to shot boundaries (if requested).
GoogleCloudVideointelligenceV1VideoSegment segment;
GoogleCloudVideointelligenceV1LabelLocation();
@@ -206,12 +217,14 @@ class GoogleCloudVideointelligenceV1LabelLocation {
level = _json["level"];
}
if (_json.containsKey("segment")) {
- segment = new GoogleCloudVideointelligenceV1VideoSegment.fromJson(_json["segment"]);
+ segment = new GoogleCloudVideointelligenceV1VideoSegment.fromJson(
+ _json["segment"]);
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (confidence != null) {
_json["confidence"] = confidence;
}
@@ -225,27 +238,22 @@ class GoogleCloudVideointelligenceV1LabelLocation {
}
}
-/**
- * Safe search annotation (based on per-frame visual signals only).
- * If no unsafe content has been detected in a frame, no annotations
- * are present for that frame.
- */
+/// Safe search annotation (based on per-frame visual signals only).
+/// If no unsafe content has been detected in a frame, no annotations
+/// are present for that frame.
class GoogleCloudVideointelligenceV1SafeSearchAnnotation {
- /**
- * Likelihood of adult content.
- * Possible string values are:
- * - "UNKNOWN" : Unknown likelihood.
- * - "VERY_UNLIKELY" : Very unlikely.
- * - "UNLIKELY" : Unlikely.
- * - "POSSIBLE" : Possible.
- * - "LIKELY" : Likely.
- * - "VERY_LIKELY" : Very likely.
- */
+ /// Likelihood of adult content.
+ /// Possible string values are:
+ /// - "UNKNOWN" : Unknown likelihood.
+ /// - "VERY_UNLIKELY" : Very unlikely.
+ /// - "UNLIKELY" : Unlikely.
+ /// - "POSSIBLE" : Possible.
+ /// - "LIKELY" : Likely.
+ /// - "VERY_LIKELY" : Very likely.
core.String adult;
- /**
- * Time-offset, relative to the beginning of the video,
- * corresponding to the video frame for this annotation.
- */
+
+ /// Time-offset, relative to the beginning of the video,
+ /// corresponding to the video frame for this annotation.
core.String time;
GoogleCloudVideointelligenceV1SafeSearchAnnotation();
@@ -260,7 +268,8 @@ class GoogleCloudVideointelligenceV1SafeSearchAnnotation {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (adult != null) {
_json["adult"] = adult;
}
@@ -271,26 +280,26 @@ class GoogleCloudVideointelligenceV1SafeSearchAnnotation {
}
}
-/** Annotation progress for a single video. */
+/// Annotation progress for a single video.
class GoogleCloudVideointelligenceV1VideoAnnotationProgress {
- /**
- * Video file location in
- * [Google Cloud Storage](https://cloud.google.com/storage/).
- */
+ /// Video file location in
+ /// [Google Cloud Storage](https://cloud.google.com/storage/).
core.String inputUri;
- /**
- * Approximate percentage processed thus far.
- * Guaranteed to be 100 when fully processed.
- */
+
+ /// Approximate percentage processed thus far.
+ /// Guaranteed to be 100 when fully processed.
core.int progressPercent;
- /** Time when the request was received. */
+
+ /// Time when the request was received.
core.String startTime;
- /** Time of the most recent update. */
+
+ /// Time of the most recent update.
core.String updateTime;
GoogleCloudVideointelligenceV1VideoAnnotationProgress();
- GoogleCloudVideointelligenceV1VideoAnnotationProgress.fromJson(core.Map _json) {
+ GoogleCloudVideointelligenceV1VideoAnnotationProgress.fromJson(
+ core.Map _json) {
if (_json.containsKey("inputUri")) {
inputUri = _json["inputUri"];
}
@@ -306,7 +315,8 @@ class GoogleCloudVideointelligenceV1VideoAnnotationProgress {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (inputUri != null) {
_json["inputUri"] = inputUri;
}
@@ -323,28 +333,30 @@ class GoogleCloudVideointelligenceV1VideoAnnotationProgress {
}
}
-/** Annotation results for a single video. */
+/// Annotation results for a single video.
class GoogleCloudVideointelligenceV1VideoAnnotationResults {
- /**
- * If set, indicates an error. Note that for a single `AnnotateVideoRequest`
- * some videos may succeed and some may fail.
- */
+ /// If set, indicates an error. Note that for a single `AnnotateVideoRequest`
+ /// some videos may succeed and some may fail.
GoogleRpcStatus error;
- /**
- * Video file location in
- * [Google Cloud Storage](https://cloud.google.com/storage/).
- */
+
+ /// Video file location in
+ /// [Google Cloud Storage](https://cloud.google.com/storage/).
core.String inputUri;
- /** Label annotations. There is exactly one element for each unique label. */
+
+ /// Label annotations. There is exactly one element for each unique label.
core.List<GoogleCloudVideointelligenceV1LabelAnnotation> labelAnnotations;
- /** Safe search annotations. */
- core.List<GoogleCloudVideointelligenceV1SafeSearchAnnotation> safeSearchAnnotations;
- /** Shot annotations. Each shot is represented as a video segment. */
+
+ /// Safe search annotations.
+ core.List<GoogleCloudVideointelligenceV1SafeSearchAnnotation>
+ safeSearchAnnotations;
+
+ /// Shot annotations. Each shot is represented as a video segment.
core.List<GoogleCloudVideointelligenceV1VideoSegment> shotAnnotations;
GoogleCloudVideointelligenceV1VideoAnnotationResults();
- GoogleCloudVideointelligenceV1VideoAnnotationResults.fromJson(core.Map _json) {
+ GoogleCloudVideointelligenceV1VideoAnnotationResults.fromJson(
+ core.Map _json) {
if (_json.containsKey("error")) {
error = new GoogleRpcStatus.fromJson(_json["error"]);
}
@@ -352,18 +364,29 @@ class GoogleCloudVideointelligenceV1VideoAnnotationResults {
inputUri = _json["inputUri"];
}
if (_json.containsKey("labelAnnotations")) {
- labelAnnotations = _json["labelAnnotations"].map((value) => new GoogleCloudVideointelligenceV1LabelAnnotation.fromJson(value)).toList();
+ labelAnnotations = _json["labelAnnotations"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1LabelAnnotation.fromJson(value))
+ .toList();
}
if (_json.containsKey("safeSearchAnnotations")) {
- safeSearchAnnotations = _json["safeSearchAnnotations"].map((value) => new GoogleCloudVideointelligenceV1SafeSearchAnnotation.fromJson(value)).toList();
+ safeSearchAnnotations = _json["safeSearchAnnotations"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1SafeSearchAnnotation.fromJson(
+ value))
+ .toList();
}
if (_json.containsKey("shotAnnotations")) {
- shotAnnotations = _json["shotAnnotations"].map((value) => new GoogleCloudVideointelligenceV1VideoSegment.fromJson(value)).toList();
+ shotAnnotations = _json["shotAnnotations"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1VideoSegment.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (error != null) {
_json["error"] = (error).toJson();
}
@@ -371,29 +394,29 @@ class GoogleCloudVideointelligenceV1VideoAnnotationResults {
_json["inputUri"] = inputUri;
}
if (labelAnnotations != null) {
- _json["labelAnnotations"] = labelAnnotations.map((value) => (value).toJson()).toList();
+ _json["labelAnnotations"] =
+ labelAnnotations.map((value) => (value).toJson()).toList();
}
if (safeSearchAnnotations != null) {
- _json["safeSearchAnnotations"] = safeSearchAnnotations.map((value) => (value).toJson()).toList();
+ _json["safeSearchAnnotations"] =
+ safeSearchAnnotations.map((value) => (value).toJson()).toList();
}
if (shotAnnotations != null) {
- _json["shotAnnotations"] = shotAnnotations.map((value) => (value).toJson()).toList();
+ _json["shotAnnotations"] =
+ shotAnnotations.map((value) => (value).toJson()).toList();
}
return _json;
}
}
-/** Video segment. */
+/// Video segment.
class GoogleCloudVideointelligenceV1VideoSegment {
- /**
- * Time-offset, relative to the beginning of the video,
- * corresponding to the end of the segment (inclusive).
- */
+ /// Time-offset, relative to the beginning of the video,
+ /// corresponding to the end of the segment (inclusive).
core.String endTime;
- /**
- * Time-offset, relative to the beginning of the video,
- * corresponding to the start of the segment (inclusive).
- */
+
+ /// Time-offset, relative to the beginning of the video,
+ /// corresponding to the start of the segment (inclusive).
core.String startTime;
GoogleCloudVideointelligenceV1VideoSegment();
@@ -408,7 +431,8 @@ class GoogleCloudVideointelligenceV1VideoSegment {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (endTime != null) {
_json["endTime"] = endTime;
}
@@ -419,75 +443,81 @@ class GoogleCloudVideointelligenceV1VideoSegment {
}
}
-/**
- * Video annotation progress. Included in the `metadata`
- * field of the `Operation` returned by the `GetOperation`
- * call of the `google::longrunning::Operations` service.
- */
+/// Video annotation progress. Included in the `metadata`
+/// field of the `Operation` returned by the `GetOperation`
+/// call of the `google::longrunning::Operations` service.
class GoogleCloudVideointelligenceV1beta1AnnotateVideoProgress {
- /** Progress metadata for all videos specified in `AnnotateVideoRequest`. */
- core.List<GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress> annotationProgress;
+ /// Progress metadata for all videos specified in `AnnotateVideoRequest`.
+ core.List<GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress>
+ annotationProgress;
GoogleCloudVideointelligenceV1beta1AnnotateVideoProgress();
- GoogleCloudVideointelligenceV1beta1AnnotateVideoProgress.fromJson(core.Map _json) {
+ GoogleCloudVideointelligenceV1beta1AnnotateVideoProgress.fromJson(
+ core.Map _json) {
if (_json.containsKey("annotationProgress")) {
- annotationProgress = _json["annotationProgress"].map((value) => new GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress.fromJson(value)).toList();
+ annotationProgress = _json["annotationProgress"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress
+ .fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (annotationProgress != null) {
- _json["annotationProgress"] = annotationProgress.map((value) => (value).toJson()).toList();
+ _json["annotationProgress"] =
+ annotationProgress.map((value) => (value).toJson()).toList();
}
return _json;
}
}
-/** Video annotation request. */
+/// Video annotation request.
class GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest {
- /** Requested video annotation features. */
+ /// Requested video annotation features.
core.List<core.String> features;
- /**
- * The video data bytes. Encoding: base64. If unset, the input video(s)
- * should be specified via `input_uri`. If set, `input_uri` should be unset.
- */
+
+ /// The video data bytes. Encoding: base64. If unset, the input video(s)
+ /// should be specified via `input_uri`. If set, `input_uri` should be unset.
core.String inputContent;
- /**
- * Input video location. Currently, only
- * [Google Cloud Storage](https://cloud.google.com/storage/) URIs are
- * supported, which must be specified in the following format:
- * `gs://bucket-id/object-id` (other URI formats return
- * google.rpc.Code.INVALID_ARGUMENT). For more information, see
- * [Request URIs](/storage/docs/reference-uris).
- * A video URI may include wildcards in `object-id`, and thus identify
- * multiple videos. Supported wildcards: '*' to match 0 or more characters;
- * '?' to match 1 character. If unset, the input video should be embedded
- * in the request as `input_content`. If set, `input_content` should be unset.
- */
+
+ /// Input video location. Currently, only
+ /// [Google Cloud Storage](https://cloud.google.com/storage/) URIs are
+ /// supported, which must be specified in the following format:
+ /// `gs://bucket-id/object-id` (other URI formats return
+ /// google.rpc.Code.INVALID_ARGUMENT). For more information, see
+ /// [Request URIs](/storage/docs/reference-uris).
+ /// A video URI may include wildcards in `object-id`, and thus identify
+ /// multiple videos. Supported wildcards: '*' to match 0 or more characters;
+ /// '?' to match 1 character. If unset, the input video should be embedded
+ /// in the request as `input_content`. If set, `input_content` should be
+ /// unset.
core.String inputUri;
- /**
- * Optional cloud region where annotation should take place. Supported cloud
- * regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region
- * is specified, a region will be determined based on video file location.
- */
+
+ /// Optional cloud region where annotation should take place. Supported cloud
+ /// regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no
+ /// region
+ /// is specified, a region will be determined based on video file location.
core.String locationId;
- /**
- * Optional location where the output (in JSON format) should be stored.
- * Currently, only [Google Cloud Storage](https://cloud.google.com/storage/)
- * URIs are supported, which must be specified in the following format:
- * `gs://bucket-id/object-id` (other URI formats return
- * google.rpc.Code.INVALID_ARGUMENT). For more information, see
- * [Request URIs](/storage/docs/reference-uris).
- */
+
+ /// Optional location where the output (in JSON format) should be stored.
+ /// Currently, only [Google Cloud Storage](https://cloud.google.com/storage/)
+ /// URIs are supported, which must be specified in the following format:
+ /// `gs://bucket-id/object-id` (other URI formats return
+ /// google.rpc.Code.INVALID_ARGUMENT). For more information, see
+ /// [Request URIs](/storage/docs/reference-uris).
core.String outputUri;
- /** Additional video context and/or feature-specific parameters. */
+
+ /// Additional video context and/or feature-specific parameters.
GoogleCloudVideointelligenceV1beta1VideoContext videoContext;
GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest();
- GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest.fromJson(core.Map _json) {
+ GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest.fromJson(
+ core.Map _json) {
if (_json.containsKey("features")) {
features = _json["features"];
}
@@ -504,12 +534,15 @@ class GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest {
outputUri = _json["outputUri"];
}
if (_json.containsKey("videoContext")) {
- videoContext = new GoogleCloudVideointelligenceV1beta1VideoContext.fromJson(_json["videoContext"]);
+ videoContext =
+ new GoogleCloudVideointelligenceV1beta1VideoContext.fromJson(
+ _json["videoContext"]);
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (features != null) {
_json["features"] = features;
}
@@ -532,39 +565,47 @@ class GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest {
}
}
-/**
- * Video annotation response. Included in the `response`
- * field of the `Operation` returned by the `GetOperation`
- * call of the `google::longrunning::Operations` service.
- */
+/// Video annotation response. Included in the `response`
+/// field of the `Operation` returned by the `GetOperation`
+/// call of the `google::longrunning::Operations` service.
class GoogleCloudVideointelligenceV1beta1AnnotateVideoResponse {
- /** Annotation results for all videos specified in `AnnotateVideoRequest`. */
- core.List<GoogleCloudVideointelligenceV1beta1VideoAnnotationResults> annotationResults;
+ /// Annotation results for all videos specified in `AnnotateVideoRequest`.
+ core.List<GoogleCloudVideointelligenceV1beta1VideoAnnotationResults>
+ annotationResults;
GoogleCloudVideointelligenceV1beta1AnnotateVideoResponse();
- GoogleCloudVideointelligenceV1beta1AnnotateVideoResponse.fromJson(core.Map _json) {
+ GoogleCloudVideointelligenceV1beta1AnnotateVideoResponse.fromJson(
+ core.Map _json) {
if (_json.containsKey("annotationResults")) {
- annotationResults = _json["annotationResults"].map((value) => new GoogleCloudVideointelligenceV1beta1VideoAnnotationResults.fromJson(value)).toList();
+ annotationResults = _json["annotationResults"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta1VideoAnnotationResults
+ .fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (annotationResults != null) {
- _json["annotationResults"] = annotationResults.map((value) => (value).toJson()).toList();
+ _json["annotationResults"] =
+ annotationResults.map((value) => (value).toJson()).toList();
}
return _json;
}
}
-/** Label annotation. */
+/// Label annotation.
class GoogleCloudVideointelligenceV1beta1LabelAnnotation {
- /** Textual description, e.g. `Fixed-gear bicycle`. */
+ /// Textual description, e.g. `Fixed-gear bicycle`.
core.String description;
- /** Language code for `description` in BCP-47 format. */
+
+ /// Language code for `description` in BCP-47 format.
core.String languageCode;
- /** Where the label was detected and with what confidence. */
+
+ /// Where the label was detected and with what confidence.
core.List<GoogleCloudVideointelligenceV1beta1LabelLocation> locations;
GoogleCloudVideointelligenceV1beta1LabelAnnotation();
@@ -577,12 +618,17 @@ class GoogleCloudVideointelligenceV1beta1LabelAnnotation {
languageCode = _json["languageCode"];
}
if (_json.containsKey("locations")) {
- locations = _json["locations"].map((value) => new GoogleCloudVideointelligenceV1beta1LabelLocation.fromJson(value)).toList();
+ locations = _json["locations"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta1LabelLocation.fromJson(
+ value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (description != null) {
_json["description"] = description;
}
@@ -596,29 +642,27 @@ class GoogleCloudVideointelligenceV1beta1LabelAnnotation {
}
}
-/** Label location. */
+/// Label location.
class GoogleCloudVideointelligenceV1beta1LabelLocation {
- /** Confidence that the label is accurate. Range: [0, 1]. */
+ /// Confidence that the label is accurate. Range: [0, 1].
core.double confidence;
- /**
- * Label level.
- * Possible string values are:
- * - "LABEL_LEVEL_UNSPECIFIED" : Unspecified.
- * - "VIDEO_LEVEL" : Video-level. Corresponds to the whole video.
- * - "SEGMENT_LEVEL" : Segment-level. Corresponds to one of
- * `AnnotateSpec.segments`.
- * - "SHOT_LEVEL" : Shot-level. Corresponds to a single shot (i.e. a series of
- * frames
- * without a major camera position or background change).
- * - "FRAME_LEVEL" : Frame-level. Corresponds to a single video frame.
- */
+
+ /// Label level.
+ /// Possible string values are:
+ /// - "LABEL_LEVEL_UNSPECIFIED" : Unspecified.
+ /// - "VIDEO_LEVEL" : Video-level. Corresponds to the whole video.
+ /// - "SEGMENT_LEVEL" : Segment-level. Corresponds to one of
+ /// `AnnotateSpec.segments`.
+ /// - "SHOT_LEVEL" : Shot-level. Corresponds to a single shot (i.e. a series
+ /// of frames
+ /// without a major camera position or background change).
+ /// - "FRAME_LEVEL" : Frame-level. Corresponds to a single video frame.
core.String level;
- /**
- * Video segment. Set to [-1, -1] for video-level labels.
- * Set to [timestamp, timestamp] for frame-level labels.
- * Otherwise, corresponds to one of `AnnotateSpec.segments`
- * (if specified) or to shot boundaries (if requested).
- */
+
+ /// Video segment. Set to [-1, -1] for video-level labels.
+ /// Set to [timestamp, timestamp] for frame-level labels.
+ /// Otherwise, corresponds to one of `AnnotateSpec.segments`
+ /// (if specified) or to shot boundaries (if requested).
GoogleCloudVideointelligenceV1beta1VideoSegment segment;
GoogleCloudVideointelligenceV1beta1LabelLocation();
@@ -631,12 +675,14 @@ class GoogleCloudVideointelligenceV1beta1LabelLocation {
level = _json["level"];
}
if (_json.containsKey("segment")) {
- segment = new GoogleCloudVideointelligenceV1beta1VideoSegment.fromJson(_json["segment"]);
+ segment = new GoogleCloudVideointelligenceV1beta1VideoSegment.fromJson(
+ _json["segment"]);
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (confidence != null) {
_json["confidence"] = confidence;
}
@@ -650,76 +696,70 @@ class GoogleCloudVideointelligenceV1beta1LabelLocation {
}
}
-/**
- * Safe search annotation (based on per-frame visual signals only).
- * If no unsafe content has been detected in a frame, no annotations
- * are present for that frame. If only some types of unsafe content
- * have been detected in a frame, the likelihood is set to `UNKNOWN`
- * for all other types of unsafe content.
- */
+/// Safe search annotation (based on per-frame visual signals only).
+/// If no unsafe content has been detected in a frame, no annotations
+/// are present for that frame. If only some types of unsafe content
+/// have been detected in a frame, the likelihood is set to `UNKNOWN`
+/// for all other types of unsafe content.
class GoogleCloudVideointelligenceV1beta1SafeSearchAnnotation {
- /**
- * Likelihood of adult content.
- * Possible string values are:
- * - "UNKNOWN" : Unknown likelihood.
- * - "VERY_UNLIKELY" : Very unlikely.
- * - "UNLIKELY" : Unlikely.
- * - "POSSIBLE" : Possible.
- * - "LIKELY" : Likely.
- * - "VERY_LIKELY" : Very likely.
- */
+ /// Likelihood of adult content.
+ /// Possible string values are:
+ /// - "UNKNOWN" : Unknown likelihood.
+ /// - "VERY_UNLIKELY" : Very unlikely.
+ /// - "UNLIKELY" : Unlikely.
+ /// - "POSSIBLE" : Possible.
+ /// - "LIKELY" : Likely.
+ /// - "VERY_LIKELY" : Very likely.
core.String adult;
- /**
- * Likelihood of medical content.
- * Possible string values are:
- * - "UNKNOWN" : Unknown likelihood.
- * - "VERY_UNLIKELY" : Very unlikely.
- * - "UNLIKELY" : Unlikely.
- * - "POSSIBLE" : Possible.
- * - "LIKELY" : Likely.
- * - "VERY_LIKELY" : Very likely.
- */
+
+ /// Likelihood of medical content.
+ /// Possible string values are:
+ /// - "UNKNOWN" : Unknown likelihood.
+ /// - "VERY_UNLIKELY" : Very unlikely.
+ /// - "UNLIKELY" : Unlikely.
+ /// - "POSSIBLE" : Possible.
+ /// - "LIKELY" : Likely.
+ /// - "VERY_LIKELY" : Very likely.
core.String medical;
- /**
- * Likelihood of racy content.
- * Possible string values are:
- * - "UNKNOWN" : Unknown likelihood.
- * - "VERY_UNLIKELY" : Very unlikely.
- * - "UNLIKELY" : Unlikely.
- * - "POSSIBLE" : Possible.
- * - "LIKELY" : Likely.
- * - "VERY_LIKELY" : Very likely.
- */
+
+ /// Likelihood of racy content.
+ /// Possible string values are:
+ /// - "UNKNOWN" : Unknown likelihood.
+ /// - "VERY_UNLIKELY" : Very unlikely.
+ /// - "UNLIKELY" : Unlikely.
+ /// - "POSSIBLE" : Possible.
+ /// - "LIKELY" : Likely.
+ /// - "VERY_LIKELY" : Very likely.
core.String racy;
- /**
- * Likelihood that an obvious modification was made to the original
- * version to make it appear funny or offensive.
- * Possible string values are:
- * - "UNKNOWN" : Unknown likelihood.
- * - "VERY_UNLIKELY" : Very unlikely.
- * - "UNLIKELY" : Unlikely.
- * - "POSSIBLE" : Possible.
- * - "LIKELY" : Likely.
- * - "VERY_LIKELY" : Very likely.
- */
+
+ /// Likelihood that an obvious modification was made to the original
+ /// version to make it appear funny or offensive.
+ /// Possible string values are:
+ /// - "UNKNOWN" : Unknown likelihood.
+ /// - "VERY_UNLIKELY" : Very unlikely.
+ /// - "UNLIKELY" : Unlikely.
+ /// - "POSSIBLE" : Possible.
+ /// - "LIKELY" : Likely.
+ /// - "VERY_LIKELY" : Very likely.
core.String spoof;
- /** Video time offset in microseconds. */
+
+ /// Video time offset in microseconds.
core.String timeOffset;
- /**
- * Likelihood of violent content.
- * Possible string values are:
- * - "UNKNOWN" : Unknown likelihood.
- * - "VERY_UNLIKELY" : Very unlikely.
- * - "UNLIKELY" : Unlikely.
- * - "POSSIBLE" : Possible.
- * - "LIKELY" : Likely.
- * - "VERY_LIKELY" : Very likely.
- */
+
+ /// Likelihood of violent content.
+ /// Possible string values are:
+ /// - "UNKNOWN" : Unknown likelihood.
+ /// - "VERY_UNLIKELY" : Very unlikely.
+ /// - "UNLIKELY" : Unlikely.
+ /// - "POSSIBLE" : Possible.
+ /// - "LIKELY" : Likely.
+ /// - "VERY_LIKELY" : Very likely.
core.String violent;
GoogleCloudVideointelligenceV1beta1SafeSearchAnnotation();
- GoogleCloudVideointelligenceV1beta1SafeSearchAnnotation.fromJson(core.Map _json) {
+ GoogleCloudVideointelligenceV1beta1SafeSearchAnnotation.fromJson(
+ core.Map _json) {
if (_json.containsKey("adult")) {
adult = _json["adult"];
}
@@ -741,7 +781,8 @@ class GoogleCloudVideointelligenceV1beta1SafeSearchAnnotation {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (adult != null) {
_json["adult"] = adult;
}
@@ -764,26 +805,26 @@ class GoogleCloudVideointelligenceV1beta1SafeSearchAnnotation {
}
}
-/** Annotation progress for a single video. */
+/// Annotation progress for a single video.
class GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress {
- /**
- * Video file location in
- * [Google Cloud Storage](https://cloud.google.com/storage/).
- */
+ /// Video file location in
+ /// [Google Cloud Storage](https://cloud.google.com/storage/).
core.String inputUri;
- /**
- * Approximate percentage processed thus far.
- * Guaranteed to be 100 when fully processed.
- */
+
+ /// Approximate percentage processed thus far.
+ /// Guaranteed to be 100 when fully processed.
core.int progressPercent;
- /** Time when the request was received. */
+
+ /// Time when the request was received.
core.String startTime;
- /** Time of the most recent update. */
+
+ /// Time of the most recent update.
core.String updateTime;
GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress();
- GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress.fromJson(core.Map _json) {
+ GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress.fromJson(
+ core.Map _json) {
if (_json.containsKey("inputUri")) {
inputUri = _json["inputUri"];
}
@@ -799,7 +840,8 @@ class GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (inputUri != null) {
_json["inputUri"] = inputUri;
}
@@ -816,28 +858,31 @@ class GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress {
}
}
-/** Annotation results for a single video. */
+/// Annotation results for a single video.
class GoogleCloudVideointelligenceV1beta1VideoAnnotationResults {
- /**
- * If set, indicates an error. Note that for a single `AnnotateVideoRequest`
- * some videos may succeed and some may fail.
- */
+ /// If set, indicates an error. Note that for a single `AnnotateVideoRequest`
+ /// some videos may succeed and some may fail.
GoogleRpcStatus error;
- /**
- * Video file location in
- * [Google Cloud Storage](https://cloud.google.com/storage/).
- */
+
+ /// Video file location in
+ /// [Google Cloud Storage](https://cloud.google.com/storage/).
core.String inputUri;
- /** Label annotations. There is exactly one element for each unique label. */
- core.List<GoogleCloudVideointelligenceV1beta1LabelAnnotation> labelAnnotations;
- /** Safe search annotations. */
- core.List<GoogleCloudVideointelligenceV1beta1SafeSearchAnnotation> safeSearchAnnotations;
- /** Shot annotations. Each shot is represented as a video segment. */
+
+ /// Label annotations. There is exactly one element for each unique label.
+ core.List<GoogleCloudVideointelligenceV1beta1LabelAnnotation>
+ labelAnnotations;
+
+ /// Safe search annotations.
+ core.List<GoogleCloudVideointelligenceV1beta1SafeSearchAnnotation>
+ safeSearchAnnotations;
+
+ /// Shot annotations. Each shot is represented as a video segment.
core.List<GoogleCloudVideointelligenceV1beta1VideoSegment> shotAnnotations;
GoogleCloudVideointelligenceV1beta1VideoAnnotationResults();
- GoogleCloudVideointelligenceV1beta1VideoAnnotationResults.fromJson(core.Map _json) {
+ GoogleCloudVideointelligenceV1beta1VideoAnnotationResults.fromJson(
+ core.Map _json) {
if (_json.containsKey("error")) {
error = new GoogleRpcStatus.fromJson(_json["error"]);
}
@@ -845,18 +890,31 @@ class GoogleCloudVideointelligenceV1beta1VideoAnnotationResults {
inputUri = _json["inputUri"];
}
if (_json.containsKey("labelAnnotations")) {
- labelAnnotations = _json["labelAnnotations"].map((value) => new GoogleCloudVideointelligenceV1beta1LabelAnnotation.fromJson(value)).toList();
+ labelAnnotations = _json["labelAnnotations"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta1LabelAnnotation.fromJson(
+ value))
+ .toList();
}
if (_json.containsKey("safeSearchAnnotations")) {
- safeSearchAnnotations = _json["safeSearchAnnotations"].map((value) => new GoogleCloudVideointelligenceV1beta1SafeSearchAnnotation.fromJson(value)).toList();
+ safeSearchAnnotations = _json["safeSearchAnnotations"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta1SafeSearchAnnotation
+ .fromJson(value))
+ .toList();
}
if (_json.containsKey("shotAnnotations")) {
- shotAnnotations = _json["shotAnnotations"].map((value) => new GoogleCloudVideointelligenceV1beta1VideoSegment.fromJson(value)).toList();
+ shotAnnotations = _json["shotAnnotations"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta1VideoSegment.fromJson(
+ value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (error != null) {
_json["error"] = (error).toJson();
}
@@ -864,56 +922,54 @@ class GoogleCloudVideointelligenceV1beta1VideoAnnotationResults {
_json["inputUri"] = inputUri;
}
if (labelAnnotations != null) {
- _json["labelAnnotations"] = labelAnnotations.map((value) => (value).toJson()).toList();
+ _json["labelAnnotations"] =
+ labelAnnotations.map((value) => (value).toJson()).toList();
}
if (safeSearchAnnotations != null) {
- _json["safeSearchAnnotations"] = safeSearchAnnotations.map((value) => (value).toJson()).toList();
+ _json["safeSearchAnnotations"] =
+ safeSearchAnnotations.map((value) => (value).toJson()).toList();
}
if (shotAnnotations != null) {
- _json["shotAnnotations"] = shotAnnotations.map((value) => (value).toJson()).toList();
+ _json["shotAnnotations"] =
+ shotAnnotations.map((value) => (value).toJson()).toList();
}
return _json;
}
}
-/** Video context and/or feature-specific parameters. */
+/// Video context and/or feature-specific parameters.
class GoogleCloudVideointelligenceV1beta1VideoContext {
- /**
- * If label detection has been requested, what labels should be detected
- * in addition to video-level labels or segment-level labels. If unspecified,
- * defaults to `SHOT_MODE`.
- * Possible string values are:
- * - "LABEL_DETECTION_MODE_UNSPECIFIED" : Unspecified.
- * - "SHOT_MODE" : Detect shot-level labels.
- * - "FRAME_MODE" : Detect frame-level labels.
- * - "SHOT_AND_FRAME_MODE" : Detect both shot-level and frame-level labels.
- */
+ /// If label detection has been requested, what labels should be detected
+ /// in addition to video-level labels or segment-level labels. If
+ /// unspecified,
+ /// defaults to `SHOT_MODE`.
+ /// Possible string values are:
+ /// - "LABEL_DETECTION_MODE_UNSPECIFIED" : Unspecified.
+ /// - "SHOT_MODE" : Detect shot-level labels.
+ /// - "FRAME_MODE" : Detect frame-level labels.
+ /// - "SHOT_AND_FRAME_MODE" : Detect both shot-level and frame-level labels.
core.String labelDetectionMode;
- /**
- * Model to use for label detection.
- * Supported values: "latest" and "stable" (the default).
- */
+
+ /// Model to use for label detection.
+ /// Supported values: "latest" and "stable" (the default).
core.String labelDetectionModel;
- /**
- * Model to use for safe search detection.
- * Supported values: "latest" and "stable" (the default).
- */
+
+ /// Model to use for safe search detection.
+ /// Supported values: "latest" and "stable" (the default).
core.String safeSearchDetectionModel;
- /**
- * Video segments to annotate. The segments may overlap and are not required
- * to be contiguous or span the whole video. If unspecified, each video
- * is treated as a single segment.
- */
+
+ /// Video segments to annotate. The segments may overlap and are not required
+ /// to be contiguous or span the whole video. If unspecified, each video
+ /// is treated as a single segment.
core.List<GoogleCloudVideointelligenceV1beta1VideoSegment> segments;
- /**
- * Model to use for shot change detection.
- * Supported values: "latest" and "stable" (the default).
- */
+
+ /// Model to use for shot change detection.
+ /// Supported values: "latest" and "stable" (the default).
core.String shotChangeDetectionModel;
- /**
- * Whether the video has been shot from a stationary (i.e. non-moving) camera.
- * When set to true, might improve detection accuracy for moving objects.
- */
+
+ /// Whether the video has been shot from a stationary (i.e. non-moving)
+ /// camera.
+ /// When set to true, might improve detection accuracy for moving objects.
core.bool stationaryCamera;
GoogleCloudVideointelligenceV1beta1VideoContext();
@@ -929,7 +985,11 @@ class GoogleCloudVideointelligenceV1beta1VideoContext {
safeSearchDetectionModel = _json["safeSearchDetectionModel"];
}
if (_json.containsKey("segments")) {
- segments = _json["segments"].map((value) => new GoogleCloudVideointelligenceV1beta1VideoSegment.fromJson(value)).toList();
+ segments = _json["segments"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta1VideoSegment.fromJson(
+ value))
+ .toList();
}
if (_json.containsKey("shotChangeDetectionModel")) {
shotChangeDetectionModel = _json["shotChangeDetectionModel"];
@@ -940,7 +1000,8 @@ class GoogleCloudVideointelligenceV1beta1VideoContext {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (labelDetectionMode != null) {
_json["labelDetectionMode"] = labelDetectionMode;
}
@@ -963,11 +1024,12 @@ class GoogleCloudVideointelligenceV1beta1VideoContext {
}
}
-/** Video segment. */
+/// Video segment.
class GoogleCloudVideointelligenceV1beta1VideoSegment {
- /** End offset in microseconds (inclusive). Unset means 0. */
+ /// End offset in microseconds (inclusive). Unset means 0.
core.String endTimeOffset;
- /** Start offset in microseconds (inclusive). Unset means 0. */
+
+ /// Start offset in microseconds (inclusive). Unset means 0.
core.String startTimeOffset;
GoogleCloudVideointelligenceV1beta1VideoSegment();
@@ -982,7 +1044,515 @@ class GoogleCloudVideointelligenceV1beta1VideoSegment {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
+ if (endTimeOffset != null) {
+ _json["endTimeOffset"] = endTimeOffset;
+ }
+ if (startTimeOffset != null) {
+ _json["startTimeOffset"] = startTimeOffset;
+ }
+ return _json;
+ }
+}
+
+/// Video annotation progress. Included in the `metadata`
+/// field of the `Operation` returned by the `GetOperation`
+/// call of the `google::longrunning::Operations` service.
+class GoogleCloudVideointelligenceV1beta2AnnotateVideoProgress {
+ /// Progress metadata for all videos specified in `AnnotateVideoRequest`.
+ core.List<GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress>
+ annotationProgress;
+
+ GoogleCloudVideointelligenceV1beta2AnnotateVideoProgress();
+
+ GoogleCloudVideointelligenceV1beta2AnnotateVideoProgress.fromJson(
+ core.Map _json) {
+ if (_json.containsKey("annotationProgress")) {
+ annotationProgress = _json["annotationProgress"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress
+ .fromJson(value))
+ .toList();
+ }
+ }
+
+ core.Map<core.String, core.Object> toJson() {
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
+ if (annotationProgress != null) {
+ _json["annotationProgress"] =
+ annotationProgress.map((value) => (value).toJson()).toList();
+ }
+ return _json;
+ }
+}
+
+/// Video annotation response. Included in the `response`
+/// field of the `Operation` returned by the `GetOperation`
+/// call of the `google::longrunning::Operations` service.
+class GoogleCloudVideointelligenceV1beta2AnnotateVideoResponse {
+ /// Annotation results for all videos specified in `AnnotateVideoRequest`.
+ core.List<GoogleCloudVideointelligenceV1beta2VideoAnnotationResults>
+ annotationResults;
+
+ GoogleCloudVideointelligenceV1beta2AnnotateVideoResponse();
+
+ GoogleCloudVideointelligenceV1beta2AnnotateVideoResponse.fromJson(
+ core.Map _json) {
+ if (_json.containsKey("annotationResults")) {
+ annotationResults = _json["annotationResults"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta2VideoAnnotationResults
+ .fromJson(value))
+ .toList();
+ }
+ }
+
+ core.Map<core.String, core.Object> toJson() {
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
+ if (annotationResults != null) {
+ _json["annotationResults"] =
+ annotationResults.map((value) => (value).toJson()).toList();
+ }
+ return _json;
+ }
+}
+
+/// Detected entity from video analysis.
+class GoogleCloudVideointelligenceV1beta2Entity {
+ /// Textual description, e.g. `Fixed-gear bicycle`.
+ core.String description;
+
+ /// Opaque entity ID. Some IDs may be available in
+ /// [Google Knowledge Graph Search
+ /// API](https://developers.google.com/knowledge-graph/).
+ core.String entityId;
+
+ /// Language code for `description` in BCP-47 format.
+ core.String languageCode;
+
+ GoogleCloudVideointelligenceV1beta2Entity();
+
+ GoogleCloudVideointelligenceV1beta2Entity.fromJson(core.Map _json) {
+ if (_json.containsKey("description")) {
+ description = _json["description"];
+ }
+ if (_json.containsKey("entityId")) {
+ entityId = _json["entityId"];
+ }
+ if (_json.containsKey("languageCode")) {
+ languageCode = _json["languageCode"];
+ }
+ }
+
+ core.Map<core.String, core.Object> toJson() {
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
+ if (description != null) {
+ _json["description"] = description;
+ }
+ if (entityId != null) {
+ _json["entityId"] = entityId;
+ }
+ if (languageCode != null) {
+ _json["languageCode"] = languageCode;
+ }
+ return _json;
+ }
+}
+
+/// Explicit content annotation (based on per-frame visual signals only).
+/// If no explicit content has been detected in a frame, no annotations are
+/// present for that frame.
+class GoogleCloudVideointelligenceV1beta2ExplicitContentAnnotation {
+ /// All video frames where explicit content was detected.
+ core.List<GoogleCloudVideointelligenceV1beta2ExplicitContentFrame> frames;
+
+ GoogleCloudVideointelligenceV1beta2ExplicitContentAnnotation();
+
+ GoogleCloudVideointelligenceV1beta2ExplicitContentAnnotation.fromJson(
+ core.Map _json) {
+ if (_json.containsKey("frames")) {
+ frames = _json["frames"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta2ExplicitContentFrame
+ .fromJson(value))
+ .toList();
+ }
+ }
+
+ core.Map<core.String, core.Object> toJson() {
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
+ if (frames != null) {
+ _json["frames"] = frames.map((value) => (value).toJson()).toList();
+ }
+ return _json;
+ }
+}
+
+/// Video frame level annotation results for explicit content.
+class GoogleCloudVideointelligenceV1beta2ExplicitContentFrame {
+ /// Likelihood of the pornography content..
+ /// Possible string values are:
+ /// - "LIKELIHOOD_UNSPECIFIED" : Unspecified likelihood.
+ /// - "VERY_UNLIKELY" : Very unlikely.
+ /// - "UNLIKELY" : Unlikely.
+ /// - "POSSIBLE" : Possible.
+ /// - "LIKELY" : Likely.
+ /// - "VERY_LIKELY" : Very likely.
+ core.String pornographyLikelihood;
+
+ /// Time-offset, relative to the beginning of the video, corresponding to the
+ /// video frame for this location.
+ core.String timeOffset;
+
+ GoogleCloudVideointelligenceV1beta2ExplicitContentFrame();
+
+ GoogleCloudVideointelligenceV1beta2ExplicitContentFrame.fromJson(
+ core.Map _json) {
+ if (_json.containsKey("pornographyLikelihood")) {
+ pornographyLikelihood = _json["pornographyLikelihood"];
+ }
+ if (_json.containsKey("timeOffset")) {
+ timeOffset = _json["timeOffset"];
+ }
+ }
+
+ core.Map<core.String, core.Object> toJson() {
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
+ if (pornographyLikelihood != null) {
+ _json["pornographyLikelihood"] = pornographyLikelihood;
+ }
+ if (timeOffset != null) {
+ _json["timeOffset"] = timeOffset;
+ }
+ return _json;
+ }
+}
+
+/// Label annotation.
+class GoogleCloudVideointelligenceV1beta2LabelAnnotation {
+ /// Common categories for the detected entity.
+ /// E.g. when the label is `Terrier` the category is likely `dog`. And in
+ /// some
+ /// cases there might be more than one categories e.g. `Terrier` could also
+ /// be
+ /// a `pet`.
+ core.List<GoogleCloudVideointelligenceV1beta2Entity> categoryEntities;
+
+ /// Detected entity.
+ GoogleCloudVideointelligenceV1beta2Entity entity;
+
+ /// All video frames where a label was detected.
+ core.List<GoogleCloudVideointelligenceV1beta2LabelFrame> frames;
+
+ /// All video segments where a label was detected.
+ core.List<GoogleCloudVideointelligenceV1beta2LabelSegment> segments;
+
+ GoogleCloudVideointelligenceV1beta2LabelAnnotation();
+
+ GoogleCloudVideointelligenceV1beta2LabelAnnotation.fromJson(core.Map _json) {
+ if (_json.containsKey("categoryEntities")) {
+ categoryEntities = _json["categoryEntities"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta2Entity.fromJson(value))
+ .toList();
+ }
+ if (_json.containsKey("entity")) {
+ entity = new GoogleCloudVideointelligenceV1beta2Entity.fromJson(
+ _json["entity"]);
+ }
+ if (_json.containsKey("frames")) {
+ frames = _json["frames"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta2LabelFrame.fromJson(value))
+ .toList();
+ }
+ if (_json.containsKey("segments")) {
+ segments = _json["segments"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta2LabelSegment.fromJson(
+ value))
+ .toList();
+ }
+ }
+
+ core.Map<core.String, core.Object> toJson() {
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
+ if (categoryEntities != null) {
+ _json["categoryEntities"] =
+ categoryEntities.map((value) => (value).toJson()).toList();
+ }
+ if (entity != null) {
+ _json["entity"] = (entity).toJson();
+ }
+ if (frames != null) {
+ _json["frames"] = frames.map((value) => (value).toJson()).toList();
+ }
+ if (segments != null) {
+ _json["segments"] = segments.map((value) => (value).toJson()).toList();
+ }
+ return _json;
+ }
+}
+
+/// Video frame level annotation results for label detection.
+class GoogleCloudVideointelligenceV1beta2LabelFrame {
+ /// Confidence that the label is accurate. Range: [0, 1].
+ core.double confidence;
+
+ /// Time-offset, relative to the beginning of the video, corresponding to the
+ /// video frame for this location.
+ core.String timeOffset;
+
+ GoogleCloudVideointelligenceV1beta2LabelFrame();
+
+ GoogleCloudVideointelligenceV1beta2LabelFrame.fromJson(core.Map _json) {
+ if (_json.containsKey("confidence")) {
+ confidence = _json["confidence"];
+ }
+ if (_json.containsKey("timeOffset")) {
+ timeOffset = _json["timeOffset"];
+ }
+ }
+
+ core.Map<core.String, core.Object> toJson() {
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
+ if (confidence != null) {
+ _json["confidence"] = confidence;
+ }
+ if (timeOffset != null) {
+ _json["timeOffset"] = timeOffset;
+ }
+ return _json;
+ }
+}
+
+/// Video segment level annotation results for label detection.
+class GoogleCloudVideointelligenceV1beta2LabelSegment {
+ /// Confidence that the label is accurate. Range: [0, 1].
+ core.double confidence;
+
+ /// Video segment where a label was detected.
+ GoogleCloudVideointelligenceV1beta2VideoSegment segment;
+
+ GoogleCloudVideointelligenceV1beta2LabelSegment();
+
+ GoogleCloudVideointelligenceV1beta2LabelSegment.fromJson(core.Map _json) {
+ if (_json.containsKey("confidence")) {
+ confidence = _json["confidence"];
+ }
+ if (_json.containsKey("segment")) {
+ segment = new GoogleCloudVideointelligenceV1beta2VideoSegment.fromJson(
+ _json["segment"]);
+ }
+ }
+
+ core.Map<core.String, core.Object> toJson() {
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
+ if (confidence != null) {
+ _json["confidence"] = confidence;
+ }
+ if (segment != null) {
+ _json["segment"] = (segment).toJson();
+ }
+ return _json;
+ }
+}
+
+/// Annotation progress for a single video.
+class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress {
+ /// Video file location in
+ /// [Google Cloud Storage](https://cloud.google.com/storage/).
+ core.String inputUri;
+
+ /// Approximate percentage processed thus far.
+ /// Guaranteed to be 100 when fully processed.
+ core.int progressPercent;
+
+ /// Time when the request was received.
+ core.String startTime;
+
+ /// Time of the most recent update.
+ core.String updateTime;
+
+ GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress();
+
+ GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress.fromJson(
+ core.Map _json) {
+ if (_json.containsKey("inputUri")) {
+ inputUri = _json["inputUri"];
+ }
+ if (_json.containsKey("progressPercent")) {
+ progressPercent = _json["progressPercent"];
+ }
+ if (_json.containsKey("startTime")) {
+ startTime = _json["startTime"];
+ }
+ if (_json.containsKey("updateTime")) {
+ updateTime = _json["updateTime"];
+ }
+ }
+
+ core.Map<core.String, core.Object> toJson() {
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
+ if (inputUri != null) {
+ _json["inputUri"] = inputUri;
+ }
+ if (progressPercent != null) {
+ _json["progressPercent"] = progressPercent;
+ }
+ if (startTime != null) {
+ _json["startTime"] = startTime;
+ }
+ if (updateTime != null) {
+ _json["updateTime"] = updateTime;
+ }
+ return _json;
+ }
+}
+
+/// Annotation results for a single video.
+class GoogleCloudVideointelligenceV1beta2VideoAnnotationResults {
+ /// If set, indicates an error. Note that for a single `AnnotateVideoRequest`
+ /// some videos may succeed and some may fail.
+ GoogleRpcStatus error;
+
+ /// Explicit content annotation.
+ GoogleCloudVideointelligenceV1beta2ExplicitContentAnnotation
+ explicitAnnotation;
+
+ /// Label annotations on frame level.
+ /// There is exactly one element for each unique label.
+ core.List<GoogleCloudVideointelligenceV1beta2LabelAnnotation>
+ frameLabelAnnotations;
+
+ /// Video file location in
+ /// [Google Cloud Storage](https://cloud.google.com/storage/).
+ core.String inputUri;
+
+ /// Label annotations on video level or user specified segment level.
+ /// There is exactly one element for each unique label.
+ core.List<GoogleCloudVideointelligenceV1beta2LabelAnnotation>
+ segmentLabelAnnotations;
+
+ /// Shot annotations. Each shot is represented as a video segment.
+ core.List<GoogleCloudVideointelligenceV1beta2VideoSegment> shotAnnotations;
+
+ /// Label annotations on shot level.
+ /// There is exactly one element for each unique label.
+ core.List<GoogleCloudVideointelligenceV1beta2LabelAnnotation>
+ shotLabelAnnotations;
+
+ GoogleCloudVideointelligenceV1beta2VideoAnnotationResults();
+
+ GoogleCloudVideointelligenceV1beta2VideoAnnotationResults.fromJson(
+ core.Map _json) {
+ if (_json.containsKey("error")) {
+ error = new GoogleRpcStatus.fromJson(_json["error"]);
+ }
+ if (_json.containsKey("explicitAnnotation")) {
+ explicitAnnotation =
+ new GoogleCloudVideointelligenceV1beta2ExplicitContentAnnotation
+ .fromJson(_json["explicitAnnotation"]);
+ }
+ if (_json.containsKey("frameLabelAnnotations")) {
+ frameLabelAnnotations = _json["frameLabelAnnotations"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta2LabelAnnotation.fromJson(
+ value))
+ .toList();
+ }
+ if (_json.containsKey("inputUri")) {
+ inputUri = _json["inputUri"];
+ }
+ if (_json.containsKey("segmentLabelAnnotations")) {
+ segmentLabelAnnotations = _json["segmentLabelAnnotations"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta2LabelAnnotation.fromJson(
+ value))
+ .toList();
+ }
+ if (_json.containsKey("shotAnnotations")) {
+ shotAnnotations = _json["shotAnnotations"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta2VideoSegment.fromJson(
+ value))
+ .toList();
+ }
+ if (_json.containsKey("shotLabelAnnotations")) {
+ shotLabelAnnotations = _json["shotLabelAnnotations"]
+ .map((value) =>
+ new GoogleCloudVideointelligenceV1beta2LabelAnnotation.fromJson(
+ value))
+ .toList();
+ }
+ }
+
+ core.Map<core.String, core.Object> toJson() {
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
+ if (error != null) {
+ _json["error"] = (error).toJson();
+ }
+ if (explicitAnnotation != null) {
+ _json["explicitAnnotation"] = (explicitAnnotation).toJson();
+ }
+ if (frameLabelAnnotations != null) {
+ _json["frameLabelAnnotations"] =
+ frameLabelAnnotations.map((value) => (value).toJson()).toList();
+ }
+ if (inputUri != null) {
+ _json["inputUri"] = inputUri;
+ }
+ if (segmentLabelAnnotations != null) {
+ _json["segmentLabelAnnotations"] =
+ segmentLabelAnnotations.map((value) => (value).toJson()).toList();
+ }
+ if (shotAnnotations != null) {
+ _json["shotAnnotations"] =
+ shotAnnotations.map((value) => (value).toJson()).toList();
+ }
+ if (shotLabelAnnotations != null) {
+ _json["shotLabelAnnotations"] =
+ shotLabelAnnotations.map((value) => (value).toJson()).toList();
+ }
+ return _json;
+ }
+}
+
+/// Video segment.
+class GoogleCloudVideointelligenceV1beta2VideoSegment {
+ /// Time-offset, relative to the beginning of the video,
+ /// corresponding to the end of the segment (inclusive).
+ core.String endTimeOffset;
+
+ /// Time-offset, relative to the beginning of the video,
+ /// corresponding to the start of the segment (inclusive).
+ core.String startTimeOffset;
+
+ GoogleCloudVideointelligenceV1beta2VideoSegment();
+
+ GoogleCloudVideointelligenceV1beta2VideoSegment.fromJson(core.Map _json) {
+ if (_json.containsKey("endTimeOffset")) {
+ endTimeOffset = _json["endTimeOffset"];
+ }
+ if (_json.containsKey("startTimeOffset")) {
+ startTimeOffset = _json["startTimeOffset"];
+ }
+ }
+
+ core.Map<core.String, core.Object> toJson() {
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (endTimeOffset != null) {
_json["endTimeOffset"] = endTimeOffset;
}
@@ -993,48 +1563,44 @@ class GoogleCloudVideointelligenceV1beta1VideoSegment {
}
}
-/**
- * This resource represents a long-running operation that is the result of a
- * network API call.
- */
+/// This resource represents a long-running operation that is the result of a
+/// network API call.
class GoogleLongrunningOperation {
- /**
- * 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.
- */
+ /// 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.
core.bool done;
- /** The error result of the operation in case of failure or cancellation. */
+
+ /// The error result of the operation in case of failure or cancellation.
GoogleRpcStatus error;
- /**
- * 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.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// 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.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> metadata;
- /**
- * 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 have the format of `operations/some/unique/name`.
- */
+
+ /// 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 have the format of `operations/some/unique/name`.
core.String name;
- /**
- * 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`.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// 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`.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> response;
GoogleLongrunningOperation();
@@ -1058,7 +1624,8 @@ class GoogleLongrunningOperation {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (done != null) {
_json["done"] = done;
}
@@ -1078,78 +1645,81 @@ class GoogleLongrunningOperation {
}
}
-/**
- * The `Status` type defines a logical error model that is suitable for
- * different
- * programming environments, including REST APIs and RPC APIs. It is used by
- * [gRPC](https://github.com/grpc). The error model is designed to be:
- *
- * - Simple to use and understand for most users
- * - Flexible enough to meet unexpected needs
- *
- * # Overview
- *
- * The `Status` message contains three pieces of data: error code, error
- * message,
- * and error details. The error code should be an enum value of
- * google.rpc.Code, but it may accept additional error codes if needed. The
- * error message should be a developer-facing English message that helps
- * developers *understand* and *resolve* the error. If a localized user-facing
- * error message is needed, put the localized message in the error details or
- * localize it in the client. The optional error details may contain arbitrary
- * information about the error. There is a predefined set of error detail types
- * in the package `google.rpc` that can be used for common error conditions.
- *
- * # Language mapping
- *
- * The `Status` message is the logical representation of the error model, but it
- * is not necessarily the actual wire format. When the `Status` message is
- * exposed in different client libraries and different wire protocols, it can be
- * mapped differently. For example, it will likely be mapped to some exceptions
- * in Java, but more likely mapped to some error codes in C.
- *
- * # Other uses
- *
- * The error model and the `Status` message can be used in a variety of
- * environments, either with or without APIs, to provide a
- * consistent developer experience across different environments.
- *
- * Example uses of this error model include:
- *
- * - Partial errors. If a service needs to return partial errors to the client,
- * it may embed the `Status` in the normal response to indicate the partial
- * errors.
- *
- * - Workflow errors. A typical workflow has multiple steps. Each step may
- * have a `Status` message for error reporting.
- *
- * - Batch operations. If a client uses batch request and batch response, the
- * `Status` message should be used directly inside batch response, one for
- * each error sub-response.
- *
- * - Asynchronous operations. If an API call embeds asynchronous operation
- * results in its response, the status of those operations should be
- * represented directly using the `Status` message.
- *
- * - Logging. If some API errors are stored in logs, the message `Status` could
- * be used directly after any stripping needed for security/privacy reasons.
- */
+/// The `Status` type defines a logical error model that is suitable for
+/// different
+/// programming environments, including REST APIs and RPC APIs. It is used by
+/// [gRPC](https://github.com/grpc). The error model is designed to be:
+///
+/// - Simple to use and understand for most users
+/// - Flexible enough to meet unexpected needs
+///
+/// # Overview
+///
+/// The `Status` message contains three pieces of data: error code, error
+/// message,
+/// and error details. The error code should be an enum value of
+/// google.rpc.Code, but it may accept additional error codes if needed. The
+/// error message should be a developer-facing English message that helps
+/// developers *understand* and *resolve* the error. If a localized user-facing
+/// error message is needed, put the localized message in the error details or
+/// localize it in the client. The optional error details may contain arbitrary
+/// information about the error. There is a predefined set of error detail
+/// types
+/// in the package `google.rpc` that can be used for common error conditions.
+///
+/// # Language mapping
+///
+/// The `Status` message is the logical representation of the error model, but
+/// it
+/// is not necessarily the actual wire format. When the `Status` message is
+/// exposed in different client libraries and different wire protocols, it can
+/// be
+/// mapped differently. For example, it will likely be mapped to some
+/// exceptions
+/// in Java, but more likely mapped to some error codes in C.
+///
+/// # Other uses
+///
+/// The error model and the `Status` message can be used in a variety of
+/// environments, either with or without APIs, to provide a
+/// consistent developer experience across different environments.
+///
+/// Example uses of this error model include:
+///
+/// - Partial errors. If a service needs to return partial errors to the
+/// client,
+/// it may embed the `Status` in the normal response to indicate the partial
+/// errors.
+///
+/// - Workflow errors. A typical workflow has multiple steps. Each step may
+/// have a `Status` message for error reporting.
+///
+/// - Batch operations. If a client uses batch request and batch response, the
+/// `Status` message should be used directly inside batch response, one for
+/// each error sub-response.
+///
+/// - Asynchronous operations. If an API call embeds asynchronous operation
+/// results in its response, the status of those operations should be
+/// represented directly using the `Status` message.
+///
+/// - Logging. If some API errors are stored in logs, the message `Status`
+/// could
+/// be used directly after any stripping needed for security/privacy reasons.
class GoogleRpcStatus {
- /** The status code, which should be an enum value of google.rpc.Code. */
+ /// The status code, which should be an enum value of google.rpc.Code.
core.int code;
- /**
- * A list of messages that carry the error details. There is a common set of
- * message types for APIs to use.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// A list of messages that carry the error details. There is a common set
+ /// of
+ /// message types for APIs to use.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.List<core.Map<core.String, core.Object>> details;
- /**
- * A developer-facing error message, which should be in English. Any
- * user-facing error message should be localized and sent in the
- * google.rpc.Status.details field, or localized by the client.
- */
+
+ /// A developer-facing error message, which should be in English. Any
+ /// user-facing error message should be localized and sent in the
+ /// google.rpc.Status.details field, or localized by the client.
core.String message;
GoogleRpcStatus();
@@ -1167,7 +1737,8 @@ class GoogleRpcStatus {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (code != null) {
_json["code"] = code;
}
« no previous file with comments | « generated/googleapis_beta/lib/toolresults/v1beta3firstparty.dart ('k') | generated/googleapis_beta/pubspec.yaml » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698