From 16cf0c3c1f8d16ede4df09c6cbbbcd87cc38ad89 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Fri, 14 Jul 2023 00:26:13 -0700 Subject: [PATCH] feat(all): auto-regenerate discovery clients (#2069) --- artifactregistry/v1/artifactregistry-api.json | 9 +- .../v1beta2/artifactregistry-api.json | 8 +- bigquery/v2/bigquery-api.json | 90 +- bigquery/v2/bigquery-gen.go | 113 +- chat/v1/chat-api.json | 104 +- chat/v1/chat-gen.go | 237 +++- clouddebugger/v2/clouddebugger-api.json | 5 +- cloudkms/v1/cloudkms-api.json | 34 +- cloudkms/v1/cloudkms-gen.go | 24 + compute/v0.alpha/compute-api.json | 86 +- compute/v0.alpha/compute-gen.go | 258 +++- compute/v0.beta/compute-api.json | 178 ++- compute/v0.beta/compute-gen.go | 596 +++++++- compute/v1/compute-api.json | 99 +- compute/v1/compute-gen.go | 285 +++- dialogflow/v2/dialogflow-api.json | 62 +- dialogflow/v2/dialogflow-gen.go | 159 ++- dialogflow/v2beta1/dialogflow-api.json | 68 +- dialogflow/v2beta1/dialogflow-gen.go | 181 +-- dialogflow/v3/dialogflow-api.json | 44 +- dialogflow/v3/dialogflow-gen.go | 111 +- discovery/v1/discovery-api.json | 19 + discovery/v1/discovery-gen.go | 27 +- displayvideo/v1/displayvideo-api.json | 4 +- displayvideo/v1/displayvideo-gen.go | 4 +- displayvideo/v2/displayvideo-api.json | 4 +- displayvideo/v2/displayvideo-gen.go | 4 +- documentai/v1/documentai-api.json | 456 +++++- documentai/v1/documentai-gen.go | 681 ++++++++- documentai/v1beta2/documentai-api.json | 362 ++++- documentai/v1beta2/documentai-gen.go | 554 +++++++- documentai/v1beta3/documentai-api.json | 548 ++++++- documentai/v1beta3/documentai-gen.go | 1260 ++++++++++++++++- .../v2/doubleclickbidmanager-api.json | 17 +- drive/v3/drive-api.json | 26 +- iam/v1/iam-api.json | 48 +- iam/v1/iam-gen.go | 41 +- iam/v2/iam-api.json | 4 +- iam/v2/iam-gen.go | 2 +- iam/v2beta/iam-api.json | 4 +- iam/v2beta/iam-gen.go | 2 +- identitytoolkit/v1/identitytoolkit-api.json | 73 +- identitytoolkit/v2/identitytoolkit-api.json | 22 +- identitytoolkit/v2/identitytoolkit-gen.go | 15 + logging/v2/logging-api.json | 11 +- logging/v2/logging-gen.go | 13 +- run/v1/run-api.json | 4 +- run/v1/run-gen.go | 1 - speech/v1/speech-api.json | 5 +- speech/v1p1beta1/speech-api.json | 8 +- storage/v1/storage-api.json | 42 +- storage/v1/storage-gen.go | 79 +- 52 files changed, 6512 insertions(+), 579 deletions(-) diff --git a/artifactregistry/v1/artifactregistry-api.json b/artifactregistry/v1/artifactregistry-api.json index 47611296da4..058f90dae1f 100644 --- a/artifactregistry/v1/artifactregistry-api.json +++ b/artifactregistry/v1/artifactregistry-api.json @@ -1661,7 +1661,7 @@ } } }, - "revision": "20230628", + "revision": "20230710", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -1844,6 +1844,7 @@ "type": "string" }, "versionAge": { + "deprecated": true, "description": "DEPRECATED: Use older_than.", "format": "google-duration", "type": "string" @@ -2788,6 +2789,12 @@ "REDIRECTION_FROM_GCR_IO_ENABLED", "REDIRECTION_FROM_GCR_IO_FINALIZED" ], + "enumDeprecated": [ + false, + false, + false, + true + ], "enumDescriptions": [ "No redirection status has been set.", "Redirection is disabled.", diff --git a/artifactregistry/v1beta2/artifactregistry-api.json b/artifactregistry/v1beta2/artifactregistry-api.json index 41a39d7f954..7e232cc3371 100644 --- a/artifactregistry/v1beta2/artifactregistry-api.json +++ b/artifactregistry/v1beta2/artifactregistry-api.json @@ -1135,7 +1135,7 @@ } } }, - "revision": "20230522", + "revision": "20230710", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -1713,6 +1713,12 @@ "REDIRECTION_FROM_GCR_IO_ENABLED", "REDIRECTION_FROM_GCR_IO_FINALIZED" ], + "enumDeprecated": [ + false, + false, + false, + true + ], "enumDescriptions": [ "No redirection status has been set.", "Redirection is disabled.", diff --git a/bigquery/v2/bigquery-api.json b/bigquery/v2/bigquery-api.json index 8ca1be473ba..ef0e3821e07 100644 --- a/bigquery/v2/bigquery-api.json +++ b/bigquery/v2/bigquery-api.json @@ -1710,7 +1710,7 @@ } } }, - "revision": "20230617", + "revision": "20230708", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -1855,6 +1855,7 @@ "id": "ArimaForecastingMetrics", "properties": { "arimaFittingMetrics": { + "deprecated": true, "description": "Arima model fitting metrics.", "items": { "$ref": "ArimaFittingMetrics" @@ -1869,6 +1870,7 @@ "type": "array" }, "hasDrift": { + "deprecated": true, "description": "Whether Arima model fitted with drift or not. It is always false when d is not 1.", "items": { "type": "boolean" @@ -1876,6 +1878,7 @@ "type": "array" }, "nonSeasonalOrder": { + "deprecated": true, "description": "Non-seasonal order.", "items": { "$ref": "ArimaOrder" @@ -1883,6 +1886,7 @@ "type": "array" }, "seasonalPeriods": { + "deprecated": true, "description": "Seasonal periods. Repeated because multiple periods are supported for one time series.", "items": { "enum": [ @@ -1908,6 +1912,7 @@ "type": "array" }, "timeSeriesId": { + "deprecated": true, "description": "Id to differentiate different time series for the large-scale case.", "items": { "type": "string" @@ -5057,6 +5062,7 @@ "id": "Model", "properties": { "bestTrialId": { + "deprecated": true, "description": "The best trial_id across all training runs.", "format": "int64", "type": "string" @@ -5092,7 +5098,7 @@ "type": "string" }, "featureColumns": { - "description": "Output only. Input feature columns that were used to train this model.", + "description": "Output only. Input feature columns for the model inference. If the model is trained with TRANSFORM clause, these are the input of the TRANSFORM clause.", "items": { "$ref": "StandardSqlField" }, @@ -7084,6 +7090,10 @@ "description": "Options used in model training.", "id": "TrainingOptions", "properties": { + "activationFn": { + "description": "Activation function of the neural nets.", + "type": "string" + }, "adjustStepChanges": { "description": "If true, detect step changes and make data adjustment in the input time series.", "type": "boolean" @@ -7106,6 +7116,10 @@ "format": "int64", "type": "string" }, + "autoClassWeights": { + "description": "Whether to calculate class weights automatically based on the popularity of each label.", + "type": "boolean" + }, "batchSize": { "description": "Batch size for dnn models.", "format": "int64", @@ -7125,6 +7139,11 @@ ], "type": "string" }, + "budgetHours": { + "description": "Budget in hours for AutoML training.", + "format": "double", + "type": "number" + }, "calculatePValues": { "description": "Whether or not p-value test should be computed for this model. Only available for linear and logistic regression models.", "type": "boolean" @@ -7282,6 +7301,10 @@ ], "type": "string" }, + "fitIntercept": { + "description": "Whether the model should include intercept during model training.", + "type": "boolean" + }, "hiddenUnits": { "description": "Hidden units for dnn models.", "items": { @@ -7535,6 +7558,11 @@ ], "type": "string" }, + "l1RegActivation": { + "description": "L1 regularization coefficient to activations.", + "format": "double", + "type": "number" + }, "l1Regularization": { "description": "L1 regularization coefficient.", "format": "double", @@ -7626,6 +7654,18 @@ "format": "int64", "type": "string" }, + "modelRegistry": { + "description": "The model registry.", + "enum": [ + "MODEL_REGISTRY_UNSPECIFIED", + "VERTEX_AI" + ], + "enumDescriptions": [ + "", + "Vertex AI." + ], + "type": "string" + }, "modelUri": { "description": "Google Cloud Storage URI from which the model was imported. Only applicable for imported models.", "type": "string" @@ -7649,6 +7689,11 @@ "format": "int64", "type": "string" }, + "numPrincipalComponents": { + "description": "Number of principal components to keep in the PCA model. Must be \u003c= the number of features.", + "format": "int64", + "type": "string" + }, "numTrials": { "description": "Number of trials to run this hyperparameter tuning job.", "format": "int64", @@ -7668,11 +7713,44 @@ ], "type": "string" }, + "optimizer": { + "description": "Optimizer used for training the neural nets.", + "type": "string" + }, + "pcaExplainedVarianceRatio": { + "description": "The minimum ratio of cumulative explained variance that needs to be given by the PCA model.", + "format": "double", + "type": "number" + }, + "pcaSolver": { + "description": "The solver for PCA.", + "enum": [ + "UNSPECIFIED", + "FULL", + "RANDOMIZED", + "AUTO" + ], + "enumDescriptions": [ + "", + "Full eigen-decoposition.", + "Randomized SVD.", + "Auto." + ], + "type": "string" + }, "sampledShapleyNumPaths": { "description": "Number of paths for the sampled Shapley explain method.", "format": "int64", "type": "string" }, + "scaleFeatures": { + "description": "If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA.", + "type": "boolean" + }, + "standardizeFeatures": { + "description": "Whether to standardize numerical features. Default to true.", + "type": "boolean" + }, "subsample": { "description": "Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.", "format": "double", @@ -7733,6 +7811,13 @@ "description": "User column specified for matrix factorization models.", "type": "string" }, + "vertexAiModelVersionAliases": { + "description": "The version aliases to apply in Vertex AI model registry. Always overwrite if the version aliases exists in a existing model.", + "items": { + "type": "string" + }, + "type": "array" + }, "walsAlpha": { "description": "Hyperparameter for matrix factoration when implicit feedback type is specified.", "format": "double", @@ -7796,6 +7881,7 @@ "readOnly": true }, "trainingStartTime": { + "deprecated": true, "description": "Output only. The start time of this training run, in milliseconds since epoch.", "format": "int64", "readOnly": true, diff --git a/bigquery/v2/bigquery-gen.go b/bigquery/v2/bigquery-gen.go index 5ff46738afb..bd34dc18253 100644 --- a/bigquery/v2/bigquery-gen.go +++ b/bigquery/v2/bigquery-gen.go @@ -5861,8 +5861,9 @@ type Model struct { // models. ExpirationTime int64 `json:"expirationTime,omitempty,string"` - // FeatureColumns: Output only. Input feature columns that were used to - // train this model. + // FeatureColumns: Output only. Input feature columns for the model + // inference. If the model is trained with TRANSFORM clause, these are + // the input of the TRANSFORM clause. FeatureColumns []*StandardSqlField `json:"featureColumns,omitempty"` // FriendlyName: Optional. A descriptive name for this model. @@ -9158,6 +9159,9 @@ func (s *TimePartitioning) MarshalJSON() ([]byte, error) { // TrainingOptions: Options used in model training. type TrainingOptions struct { + // ActivationFn: Activation function of the neural nets. + ActivationFn string `json:"activationFn,omitempty"` + // AdjustStepChanges: If true, detect step changes and make data // adjustment in the input time series. AdjustStepChanges bool `json:"adjustStepChanges,omitempty"` @@ -9175,6 +9179,10 @@ type TrainingOptions struct { // AutoArimaMinOrder: The min value of the sum of non-seasonal p and q. AutoArimaMinOrder int64 `json:"autoArimaMinOrder,omitempty,string"` + // AutoClassWeights: Whether to calculate class weights automatically + // based on the popularity of each label. + AutoClassWeights bool `json:"autoClassWeights,omitempty"` + // BatchSize: Batch size for dnn models. BatchSize int64 `json:"batchSize,omitempty,string"` @@ -9186,6 +9194,9 @@ type TrainingOptions struct { // "DART" - Dart booster. BoosterType string `json:"boosterType,omitempty"` + // BudgetHours: Budget in hours for AutoML training. + BudgetHours float64 `json:"budgetHours,omitempty"` + // CalculatePValues: Whether or not p-value test should be computed for // this model. Only available for linear and logistic regression models. CalculatePValues bool `json:"calculatePValues,omitempty"` @@ -9306,6 +9317,10 @@ type TrainingOptions struct { // "EXPLICIT" - Use nonweighted-als for explicit feedback problems. FeedbackType string `json:"feedbackType,omitempty"` + // FitIntercept: Whether the model should include intercept during model + // training. + FitIntercept bool `json:"fitIntercept,omitempty"` + // HiddenUnits: Hidden units for dnn models. HiddenUnits googleapi.Int64s `json:"hiddenUnits,omitempty"` @@ -9470,6 +9485,9 @@ type TrainingOptions struct { // "KMEANS_PLUS_PLUS" - Initializes with kmeans++. KmeansInitializationMethod string `json:"kmeansInitializationMethod,omitempty"` + // L1RegActivation: L1 regularization coefficient to activations. + L1RegActivation float64 `json:"l1RegActivation,omitempty"` + // L1Regularization: L1 regularization coefficient. L1Regularization float64 `json:"l1Regularization,omitempty"` @@ -9534,6 +9552,13 @@ type TrainingOptions struct { // for boosted tree models. MinTreeChildWeight int64 `json:"minTreeChildWeight,omitempty,string"` + // ModelRegistry: The model registry. + // + // Possible values: + // "MODEL_REGISTRY_UNSPECIFIED" + // "VERTEX_AI" - Vertex AI. + ModelRegistry string `json:"modelRegistry,omitempty"` + // ModelUri: Google Cloud Storage URI from which the model was imported. // Only applicable for imported models. ModelUri string `json:"modelUri,omitempty"` @@ -9553,6 +9578,10 @@ type TrainingOptions struct { // iteration for boosted tree models. NumParallelTree int64 `json:"numParallelTree,omitempty,string"` + // NumPrincipalComponents: Number of principal components to keep in the + // PCA model. Must be <= the number of features. + NumPrincipalComponents int64 `json:"numPrincipalComponents,omitempty,string"` + // NumTrials: Number of trials to run this hyperparameter tuning job. NumTrials int64 `json:"numTrials,omitempty,string"` @@ -9567,10 +9596,34 @@ type TrainingOptions struct { // regression problem. OptimizationStrategy string `json:"optimizationStrategy,omitempty"` + // Optimizer: Optimizer used for training the neural nets. + Optimizer string `json:"optimizer,omitempty"` + + // PcaExplainedVarianceRatio: The minimum ratio of cumulative explained + // variance that needs to be given by the PCA model. + PcaExplainedVarianceRatio float64 `json:"pcaExplainedVarianceRatio,omitempty"` + + // PcaSolver: The solver for PCA. + // + // Possible values: + // "UNSPECIFIED" + // "FULL" - Full eigen-decoposition. + // "RANDOMIZED" - Randomized SVD. + // "AUTO" - Auto. + PcaSolver string `json:"pcaSolver,omitempty"` + // SampledShapleyNumPaths: Number of paths for the sampled Shapley // explain method. SampledShapleyNumPaths int64 `json:"sampledShapleyNumPaths,omitempty,string"` + // ScaleFeatures: If true, scale the feature values by dividing the + // feature standard deviation. Currently only apply to PCA. + ScaleFeatures bool `json:"scaleFeatures,omitempty"` + + // StandardizeFeatures: Whether to standardize numerical features. + // Default to true. + StandardizeFeatures bool `json:"standardizeFeatures,omitempty"` + // Subsample: Subsample fraction of the training data to grow tree to // prevent overfitting for boosted tree models. Subsample float64 `json:"subsample,omitempty"` @@ -9617,6 +9670,11 @@ type TrainingOptions struct { // UserColumn: User column specified for matrix factorization models. UserColumn string `json:"userColumn,omitempty"` + // VertexAiModelVersionAliases: The version aliases to apply in Vertex + // AI model registry. Always overwrite if the version aliases exists in + // a existing model. + VertexAiModelVersionAliases []string `json:"vertexAiModelVersionAliases,omitempty"` + // WalsAlpha: Hyperparameter for matrix factoration when implicit // feedback type is specified. WalsAlpha float64 `json:"walsAlpha,omitempty"` @@ -9628,21 +9686,20 @@ type TrainingOptions struct { // XGBoost models. XgboostVersion string `json:"xgboostVersion,omitempty"` - // ForceSendFields is a list of field names (e.g. "AdjustStepChanges") - // to unconditionally include in API requests. By default, fields with + // ForceSendFields is a list of field names (e.g. "ActivationFn") to + // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AdjustStepChanges") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. + // NullFields is a list of field names (e.g. "ActivationFn") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } @@ -9655,37 +9712,43 @@ func (s *TrainingOptions) MarshalJSON() ([]byte, error) { func (s *TrainingOptions) UnmarshalJSON(data []byte) error { type NoMethod TrainingOptions var s1 struct { - ColsampleBylevel gensupport.JSONFloat64 `json:"colsampleBylevel"` - ColsampleBynode gensupport.JSONFloat64 `json:"colsampleBynode"` - ColsampleBytree gensupport.JSONFloat64 `json:"colsampleBytree"` - DataSplitEvalFraction gensupport.JSONFloat64 `json:"dataSplitEvalFraction"` - Dropout gensupport.JSONFloat64 `json:"dropout"` - InitialLearnRate gensupport.JSONFloat64 `json:"initialLearnRate"` - L1Regularization gensupport.JSONFloat64 `json:"l1Regularization"` - L2Regularization gensupport.JSONFloat64 `json:"l2Regularization"` - LearnRate gensupport.JSONFloat64 `json:"learnRate"` - MinRelativeProgress gensupport.JSONFloat64 `json:"minRelativeProgress"` - MinSplitLoss gensupport.JSONFloat64 `json:"minSplitLoss"` - Subsample gensupport.JSONFloat64 `json:"subsample"` - TimeSeriesLengthFraction gensupport.JSONFloat64 `json:"timeSeriesLengthFraction"` - WalsAlpha gensupport.JSONFloat64 `json:"walsAlpha"` + BudgetHours gensupport.JSONFloat64 `json:"budgetHours"` + ColsampleBylevel gensupport.JSONFloat64 `json:"colsampleBylevel"` + ColsampleBynode gensupport.JSONFloat64 `json:"colsampleBynode"` + ColsampleBytree gensupport.JSONFloat64 `json:"colsampleBytree"` + DataSplitEvalFraction gensupport.JSONFloat64 `json:"dataSplitEvalFraction"` + Dropout gensupport.JSONFloat64 `json:"dropout"` + InitialLearnRate gensupport.JSONFloat64 `json:"initialLearnRate"` + L1RegActivation gensupport.JSONFloat64 `json:"l1RegActivation"` + L1Regularization gensupport.JSONFloat64 `json:"l1Regularization"` + L2Regularization gensupport.JSONFloat64 `json:"l2Regularization"` + LearnRate gensupport.JSONFloat64 `json:"learnRate"` + MinRelativeProgress gensupport.JSONFloat64 `json:"minRelativeProgress"` + MinSplitLoss gensupport.JSONFloat64 `json:"minSplitLoss"` + PcaExplainedVarianceRatio gensupport.JSONFloat64 `json:"pcaExplainedVarianceRatio"` + Subsample gensupport.JSONFloat64 `json:"subsample"` + TimeSeriesLengthFraction gensupport.JSONFloat64 `json:"timeSeriesLengthFraction"` + WalsAlpha gensupport.JSONFloat64 `json:"walsAlpha"` *NoMethod } s1.NoMethod = (*NoMethod)(s) if err := json.Unmarshal(data, &s1); err != nil { return err } + s.BudgetHours = float64(s1.BudgetHours) s.ColsampleBylevel = float64(s1.ColsampleBylevel) s.ColsampleBynode = float64(s1.ColsampleBynode) s.ColsampleBytree = float64(s1.ColsampleBytree) s.DataSplitEvalFraction = float64(s1.DataSplitEvalFraction) s.Dropout = float64(s1.Dropout) s.InitialLearnRate = float64(s1.InitialLearnRate) + s.L1RegActivation = float64(s1.L1RegActivation) s.L1Regularization = float64(s1.L1Regularization) s.L2Regularization = float64(s1.L2Regularization) s.LearnRate = float64(s1.LearnRate) s.MinRelativeProgress = float64(s1.MinRelativeProgress) s.MinSplitLoss = float64(s1.MinSplitLoss) + s.PcaExplainedVarianceRatio = float64(s1.PcaExplainedVarianceRatio) s.Subsample = float64(s1.Subsample) s.TimeSeriesLengthFraction = float64(s1.TimeSeriesLengthFraction) s.WalsAlpha = float64(s1.WalsAlpha) diff --git a/chat/v1/chat-api.json b/chat/v1/chat-api.json index cfab877cea1..5e701abf5e1 100644 --- a/chat/v1/chat-api.json +++ b/chat/v1/chat-api.json @@ -954,7 +954,7 @@ } } }, - "revision": "20230704", + "revision": "20230711", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { @@ -1301,6 +1301,17 @@ }, "type": "object" }, + "ChatClientDataSourceMarkup": { + "description": "Chat apps only. For a `SelectionInput` widget that uses a multi-select menu, a data source from Google Chat. For example, a list of Google Chat spaces of which the user is a member. [Developer Preview](https://developers.google.com/workspace/preview).", + "id": "ChatClientDataSourceMarkup", + "properties": { + "spaceDataSource": { + "$ref": "SpaceDataSource", + "description": "A data source representing a Google Chat space. Format: spaces/{space} [Developer Preview](https://developers.google.com/workspace/preview)." + } + }, + "type": "object" + }, "Color": { "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:\u0026red green:\u0026green blue:\u0026blue alpha:\u0026alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha \u003c= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i \u003c missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", "id": "Color", @@ -1831,6 +1842,20 @@ "$ref": "GoogleAppsCardV1CardHeader", "description": "When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards. Not supported by Chat apps." }, + "sectionDividerStyle": { + "description": "The divider style between sections.", + "enum": [ + "DIVIDER_STYLE_UNSPECIFIED", + "SOLID_DIVIDER", + "NO_DIVIDER" + ], + "enumDescriptions": [ + "Don't use. Unspecified.", + "Default option. Render a solid divider between sections.", + "If set, no divider is rendered between sections." + ], + "type": "string" + }, "sections": { "description": "Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider.", "items": { @@ -2306,6 +2331,29 @@ }, "type": "object" }, + "GoogleAppsCardV1PlatformDataSource": { + "description": "Chat apps only. For a `SelectionInput` widget that uses a multi-select menu, the data from a [Google Workspace host application](https://developers.google.com/chat/api/reference/rest/v1/HostApp). Used to populate the items in the multi-select menu. [Developer Preview](https://developers.google.com/workspace/preview).", + "id": "GoogleAppsCardV1PlatformDataSource", + "properties": { + "commonDataSource": { + "description": "For a `SelectionInput` widget that uses a multi-select menu, a data source shared by all Google Workspace host applications, such as users in a Google Workspace organization. [Developer Preview](https://developers.google.com/workspace/preview).", + "enum": [ + "UNKNOWN", + "USER" + ], + "enumDescriptions": [ + "Default value. Don't use. [Developer Preview](https://developers.google.com/workspace/preview).", + "A list of users provided by the Google Workspace host application. For example, to source users from Google Chat, use the resource name of the [user](https://developers.google.com/chat/api/reference/rest/v1/User). Format: users/{user} [Developer Preview](https://developers.google.com/workspace/preview)." + ], + "type": "string" + }, + "hostAppDataSource": { + "$ref": "HostAppDataSourceMarkup", + "description": "A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. [Developer Preview](https://developers.google.com/workspace/preview)." + } + }, + "type": "object" + }, "GoogleAppsCardV1Section": { "description": "A section contains a collection of widgets that are rendered vertically in the order that they're specified.", "id": "GoogleAppsCardV1Section", @@ -2337,6 +2385,10 @@ "description": "A widget that creates one or more UI items that users can select. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs). To collect undefined or abstract data from users, use the TextInput widget.", "id": "GoogleAppsCardV1SelectionInput", "properties": { + "externalDataSource": { + "$ref": "GoogleAppsCardV1Action", + "description": "An external data source, such as a relational data base. [Developer Preview](https://developers.google.com/workspace/preview)." + }, "items": { "description": "An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.", "items": { @@ -2348,6 +2400,16 @@ "description": "The text that appears above the selection input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be \"Urgency\" or \"Select urgency\".", "type": "string" }, + "multiSelectMaxSelectedItems": { + "description": "For multi-select menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, set to 3 items. [Developer Preview](https://developers.google.com/workspace/preview).", + "format": "int32", + "type": "integer" + }, + "multiSelectMinQueryLength": { + "description": "For multi-select menus, the number of text characters that a user inputs before the Chat app queries autocomplete and displays suggested items on the card. If unspecified, set to 0 characters for static data sources and 3 characters for external data sources. [Developer Preview](https://developers.google.com/workspace/preview).", + "format": "int32", + "type": "integer" + }, "name": { "description": "The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).", "type": "string" @@ -2356,19 +2418,25 @@ "$ref": "GoogleAppsCardV1Action", "description": "If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs)." }, + "platformDataSource": { + "$ref": "GoogleAppsCardV1PlatformDataSource", + "description": "A data source from a [Google Workspace host application](https://developers.google.com/chat/api/reference/rest/v1/HostApp). [Developer Preview](https://developers.google.com/workspace/preview)." + }, "type": { "description": "The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.", "enum": [ "CHECK_BOX", "RADIO_BUTTON", "SWITCH", - "DROPDOWN" + "DROPDOWN", + "MULTI_SELECT" ], "enumDescriptions": [ "A set of checkboxes. Users can select one or more checkboxes.", "A set of radio buttons. Users can select one radio button.", "A set of switches. Users can turn on one or more switches.", - "A dropdown menu. Users can select one item from the menu." + "A dropdown menu. Users can select one item from the menu.", + "Supported by Chat apps, but not Google Workspace Add-ons. A multi-select menu for static or dynamic data. From the menu bar, users select one or more items. Users can also input values to populate dynamic data. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To populate items for a multi-select menu, you can use one of the following types of data sources: * Static data: Items are specified as `SelectionItem` objects in the widget. Up to 100 items. * Google Workspace data: Items are populated using data from a Google Workspace application, such as Google Chat users or spaces. * External data: Items are populated from a dynamic external data source. For examples of how to implement multi-select menus, see the [`SelectionInput` widget page](https://developers.google.com/chat/ui/widgets/selection-input). [Developer Preview](https://developers.google.com/workspace/preview)." ], "type": "string" } @@ -2379,10 +2447,18 @@ "description": "An item that users can select in a selection input, such as a checkbox or switch.", "id": "GoogleAppsCardV1SelectionItem", "properties": { + "bottomText": { + "description": "For multi-select menus, a text description or label that's displayed below the item's `text` field. [Developer Preview](https://developers.google.com/workspace/preview).", + "type": "string" + }, "selected": { "description": "Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.", "type": "boolean" }, + "startIconUri": { + "description": "For multi-select menus, the URL for the icon displayed next to the item's `text` field. Supports PNG and JPEG files. Must be an `HTTPS` URL. For example, `https://developers.google.com/chat/images/quickstart-app-avatar.png`. [Developer Preview](https://developers.google.com/workspace/preview).", + "type": "string" + }, "text": { "description": "The text that identifies or describes the item to users.", "type": "string" @@ -2612,6 +2688,17 @@ }, "type": "object" }, + "HostAppDataSourceMarkup": { + "description": "Chat apps only. For a `SelectionInput` widget that uses a multi-select menu, a data source from a Google Workspace host application. [Developer Preview](https://developers.google.com/workspace/preview).", + "id": "HostAppDataSourceMarkup", + "properties": { + "chatDataSource": { + "$ref": "ChatClientDataSourceMarkup", + "description": "The data source is Google Chat. [Developer Preview](https://developers.google.com/workspace/preview)." + } + }, + "type": "object" + }, "Image": { "description": "An image that's specified by a URL and can have an `onclick` action.", "id": "Image", @@ -3376,6 +3463,17 @@ }, "type": "object" }, + "SpaceDataSource": { + "description": "A data source representing a Google Chat space. Format: spaces/{space} [Developer Preview](https://developers.google.com/workspace/preview).", + "id": "SpaceDataSource", + "properties": { + "defaultToCurrentSpace": { + "description": "When `true`, uses the card's Google Chat space as the default selection. The default value is `false`. [Developer Preview](https://developers.google.com/workspace/preview).", + "type": "boolean" + } + }, + "type": "object" + }, "SpaceDetails": { "description": "Details about the space including description and rules.", "id": "SpaceDetails", diff --git a/chat/v1/chat-gen.go b/chat/v1/chat-gen.go index 7f2737bce22..de184635034 100644 --- a/chat/v1/chat-gen.go +++ b/chat/v1/chat-gen.go @@ -885,6 +885,41 @@ func (s *ChatAppLogEntry) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ChatClientDataSourceMarkup: Chat apps only. For a `SelectionInput` +// widget that uses a multi-select menu, a data source from Google Chat. +// For example, a list of Google Chat spaces of which the user is a +// member. Developer Preview +// (https://developers.google.com/workspace/preview). +type ChatClientDataSourceMarkup struct { + // SpaceDataSource: A data source representing a Google Chat space. + // Format: spaces/{space} Developer Preview + // (https://developers.google.com/workspace/preview). + SpaceDataSource *SpaceDataSource `json:"spaceDataSource,omitempty"` + + // ForceSendFields is a list of field names (e.g. "SpaceDataSource") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "SpaceDataSource") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *ChatClientDataSourceMarkup) MarshalJSON() ([]byte, error) { + type NoMethod ChatClientDataSourceMarkup + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // Color: Represents a color in the RGBA color space. This // representation is designed for simplicity of conversion to and from // color representations in various languages over compactness. For @@ -1879,6 +1914,15 @@ type GoogleAppsCardV1Card struct { // Chat apps. PeekCardHeader *GoogleAppsCardV1CardHeader `json:"peekCardHeader,omitempty"` + // SectionDividerStyle: The divider style between sections. + // + // Possible values: + // "DIVIDER_STYLE_UNSPECIFIED" - Don't use. Unspecified. + // "SOLID_DIVIDER" - Default option. Render a solid divider between + // sections. + // "NO_DIVIDER" - If set, no divider is rendered between sections. + SectionDividerStyle string `json:"sectionDividerStyle,omitempty"` + // Sections: Contains a collection of widgets. Each section has its own, // optional header. Sections are visually separated by a line divider. Sections []*GoogleAppsCardV1Section `json:"sections,omitempty"` @@ -2689,6 +2733,59 @@ func (s *GoogleAppsCardV1OpenLink) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAppsCardV1PlatformDataSource: Chat apps only. For a +// `SelectionInput` widget that uses a multi-select menu, the data from +// a Google Workspace host application +// (https://developers.google.com/chat/api/reference/rest/v1/HostApp). +// Used to populate the items in the multi-select menu. Developer +// Preview (https://developers.google.com/workspace/preview). +type GoogleAppsCardV1PlatformDataSource struct { + // CommonDataSource: For a `SelectionInput` widget that uses a + // multi-select menu, a data source shared by all Google Workspace host + // applications, such as users in a Google Workspace organization. + // Developer Preview (https://developers.google.com/workspace/preview). + // + // Possible values: + // "UNKNOWN" - Default value. Don't use. [Developer + // Preview](https://developers.google.com/workspace/preview). + // "USER" - A list of users provided by the Google Workspace host + // application. For example, to source users from Google Chat, use the + // resource name of the + // [user](https://developers.google.com/chat/api/reference/rest/v1/User). + // Format: users/{user} [Developer + // Preview](https://developers.google.com/workspace/preview). + CommonDataSource string `json:"commonDataSource,omitempty"` + + // HostAppDataSource: A data source that's unique to a Google Workspace + // host application, such as Gmail emails, Google Calendar events, or + // Google Chat messages. Developer Preview + // (https://developers.google.com/workspace/preview). + HostAppDataSource *HostAppDataSourceMarkup `json:"hostAppDataSource,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonDataSource") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CommonDataSource") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAppsCardV1PlatformDataSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAppsCardV1PlatformDataSource + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAppsCardV1Section: A section contains a collection of widgets // that are rendered vertically in the order that they're specified. type GoogleAppsCardV1Section struct { @@ -2753,6 +2850,11 @@ func (s *GoogleAppsCardV1Section) MarshalJSON() ([]byte, error) { // To collect undefined or abstract data from users, use the TextInput // widget. type GoogleAppsCardV1SelectionInput struct { + // ExternalDataSource: An external data source, such as a relational + // data base. Developer Preview + // (https://developers.google.com/workspace/preview). + ExternalDataSource *GoogleAppsCardV1Action `json:"externalDataSource,omitempty"` + // Items: An array of selectable items. For example, an array of radio // buttons or checkboxes. Supports up to 100 items. Items []*GoogleAppsCardV1SelectionItem `json:"items,omitempty"` @@ -2764,6 +2866,20 @@ type GoogleAppsCardV1SelectionInput struct { // "Urgency" or "Select urgency". Label string `json:"label,omitempty"` + // MultiSelectMaxSelectedItems: For multi-select menus, the maximum + // number of items that a user can select. Minimum value is 1 item. If + // unspecified, set to 3 items. Developer Preview + // (https://developers.google.com/workspace/preview). + MultiSelectMaxSelectedItems int64 `json:"multiSelectMaxSelectedItems,omitempty"` + + // MultiSelectMinQueryLength: For multi-select menus, the number of text + // characters that a user inputs before the Chat app queries + // autocomplete and displays suggested items on the card. If + // unspecified, set to 0 characters for static data sources and 3 + // characters for external data sources. Developer Preview + // (https://developers.google.com/workspace/preview). + MultiSelectMinQueryLength int64 `json:"multiSelectMinQueryLength,omitempty"` + // Name: The name that identifies the selection input in a form input // event. For details about working with form inputs, see Receive form // data @@ -2777,6 +2893,12 @@ type GoogleAppsCardV1SelectionInput struct { // (https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs). OnChangeAction *GoogleAppsCardV1Action `json:"onChangeAction,omitempty"` + // PlatformDataSource: A data source from a Google Workspace host + // application + // (https://developers.google.com/chat/api/reference/rest/v1/HostApp). + // Developer Preview (https://developers.google.com/workspace/preview). + PlatformDataSource *GoogleAppsCardV1PlatformDataSource `json:"platformDataSource,omitempty"` + // Type: The type of items that are displayed to users in a // `SelectionInput` widget. Selection types support different types of // interactions. For example, users can select one or more checkboxes, @@ -2791,22 +2913,38 @@ type GoogleAppsCardV1SelectionInput struct { // switches. // "DROPDOWN" - A dropdown menu. Users can select one item from the // menu. + // "MULTI_SELECT" - Supported by Chat apps, but not Google Workspace + // Add-ons. A multi-select menu for static or dynamic data. From the + // menu bar, users select one or more items. Users can also input values + // to populate dynamic data. For example, users can start typing the + // name of a Google Chat space and the widget autosuggests the space. To + // populate items for a multi-select menu, you can use one of the + // following types of data sources: * Static data: Items are specified + // as `SelectionItem` objects in the widget. Up to 100 items. * Google + // Workspace data: Items are populated using data from a Google + // Workspace application, such as Google Chat users or spaces. * + // External data: Items are populated from a dynamic external data + // source. For examples of how to implement multi-select menus, see the + // [`SelectionInput` widget + // page](https://developers.google.com/chat/ui/widgets/selection-input). + // [Developer Preview](https://developers.google.com/workspace/preview). Type string `json:"type,omitempty"` - // ForceSendFields is a list of field names (e.g. "Items") to - // unconditionally include in API requests. By default, fields with + // ForceSendFields is a list of field names (e.g. "ExternalDataSource") + // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Items") to include in API - // requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "ExternalDataSource") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. NullFields []string `json:"-"` } @@ -2819,11 +2957,23 @@ func (s *GoogleAppsCardV1SelectionInput) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1SelectionItem: An item that users can select in a // selection input, such as a checkbox or switch. type GoogleAppsCardV1SelectionItem struct { + // BottomText: For multi-select menus, a text description or label + // that's displayed below the item's `text` field. Developer Preview + // (https://developers.google.com/workspace/preview). + BottomText string `json:"bottomText,omitempty"` + // Selected: Whether the item is selected by default. If the selection // input only accepts one value (such as for radio buttons or a dropdown // menu), only set this field for one item. Selected bool `json:"selected,omitempty"` + // StartIconUri: For multi-select menus, the URL for the icon displayed + // next to the item's `text` field. Supports PNG and JPEG files. Must be + // an `HTTPS` URL. For example, + // `https://developers.google.com/chat/images/quickstart-app-avatar.png`. + // Developer Preview (https://developers.google.com/workspace/preview). + StartIconUri string `json:"startIconUri,omitempty"` + // Text: The text that identifies or describes the item to users. Text string `json:"text,omitempty"` @@ -2833,7 +2983,7 @@ type GoogleAppsCardV1SelectionItem struct { // (https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs). Value string `json:"value,omitempty"` - // ForceSendFields is a list of field names (e.g. "Selected") to + // ForceSendFields is a list of field names (e.g. "BottomText") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -2841,7 +2991,7 @@ type GoogleAppsCardV1SelectionItem struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Selected") to include in + // NullFields is a list of field names (e.g. "BottomText") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as @@ -3291,6 +3441,39 @@ func (s *GoogleAppsCardV1Widgets) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// HostAppDataSourceMarkup: Chat apps only. For a `SelectionInput` +// widget that uses a multi-select menu, a data source from a Google +// Workspace host application. Developer Preview +// (https://developers.google.com/workspace/preview). +type HostAppDataSourceMarkup struct { + // ChatDataSource: The data source is Google Chat. Developer Preview + // (https://developers.google.com/workspace/preview). + ChatDataSource *ChatClientDataSourceMarkup `json:"chatDataSource,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ChatDataSource") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ChatDataSource") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *HostAppDataSourceMarkup) MarshalJSON() ([]byte, error) { + type NoMethod HostAppDataSourceMarkup + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // Image: An image that's specified by a URL and can have an `onclick` // action. type Image struct { @@ -4414,6 +4597,40 @@ func (s *Space) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// SpaceDataSource: A data source representing a Google Chat space. +// Format: spaces/{space} Developer Preview +// (https://developers.google.com/workspace/preview). +type SpaceDataSource struct { + // DefaultToCurrentSpace: When `true`, uses the card's Google Chat space + // as the default selection. The default value is `false`. Developer + // Preview (https://developers.google.com/workspace/preview). + DefaultToCurrentSpace bool `json:"defaultToCurrentSpace,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "DefaultToCurrentSpace") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DefaultToCurrentSpace") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *SpaceDataSource) MarshalJSON() ([]byte, error) { + type NoMethod SpaceDataSource + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // SpaceDetails: Details about the space including description and // rules. type SpaceDetails struct { diff --git a/clouddebugger/v2/clouddebugger-api.json b/clouddebugger/v2/clouddebugger-api.json index 623b35b5937..2c078e57095 100644 --- a/clouddebugger/v2/clouddebugger-api.json +++ b/clouddebugger/v2/clouddebugger-api.json @@ -449,7 +449,7 @@ } } }, - "revision": "20230613", + "revision": "20230707", "rootUrl": "https://clouddebugger.googleapis.com/", "schemas": { "AliasContext": { @@ -617,6 +617,7 @@ "description": "An alias, which may be a branch or tag." }, "aliasName": { + "deprecated": true, "description": "The name of an alias (branch, tag, etc.).", "type": "string" }, @@ -692,6 +693,7 @@ "type": "string" }, "extSourceContexts": { + "deprecated": true, "description": "References to the locations and revisions of the source code used in the deployed application.", "items": { "$ref": "ExtendedSourceContext" @@ -790,6 +792,7 @@ "description": "An alias, which may be a branch or tag." }, "aliasName": { + "deprecated": true, "description": "The name of an alias (branch, tag, etc.).", "type": "string" }, diff --git a/cloudkms/v1/cloudkms-api.json b/cloudkms/v1/cloudkms-api.json index 359ac3dd4f0..d1c5bfefefe 100644 --- a/cloudkms/v1/cloudkms-api.json +++ b/cloudkms/v1/cloudkms-api.json @@ -1821,7 +1821,7 @@ } } }, - "revision": "20230625", + "revision": "20230711", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { @@ -2196,6 +2196,10 @@ "GOOGLE_SYMMETRIC_ENCRYPTION", "AES_128_GCM", "AES_256_GCM", + "AES_128_CBC", + "AES_256_CBC", + "AES_128_CTR", + "AES_256_CTR", "RSA_SIGN_PSS_2048_SHA256", "RSA_SIGN_PSS_3072_SHA256", "RSA_SIGN_PSS_4096_SHA256", @@ -2229,6 +2233,10 @@ "Creates symmetric encryption keys.", "AES-GCM (Galois Counter Mode) using 128-bit keys.", "AES-GCM (Galois Counter Mode) using 256-bit keys.", + "AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.", + "AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.", + "AES-CTR (Counter Mode) using 128-bit keys.", + "AES-CTR (Counter Mode) using 256-bit keys.", "RSASSA-PSS 2048 bit key with a SHA256 digest.", "RSASSA-PSS 3072 bit key with a SHA256 digest.", "RSASSA-PSS 4096 bit key with a SHA256 digest.", @@ -2392,6 +2400,10 @@ "GOOGLE_SYMMETRIC_ENCRYPTION", "AES_128_GCM", "AES_256_GCM", + "AES_128_CBC", + "AES_256_CBC", + "AES_128_CTR", + "AES_256_CTR", "RSA_SIGN_PSS_2048_SHA256", "RSA_SIGN_PSS_3072_SHA256", "RSA_SIGN_PSS_4096_SHA256", @@ -2425,6 +2437,10 @@ "Creates symmetric encryption keys.", "AES-GCM (Galois Counter Mode) using 128-bit keys.", "AES-GCM (Galois Counter Mode) using 256-bit keys.", + "AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.", + "AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.", + "AES-CTR (Counter Mode) using 128-bit keys.", + "AES-CTR (Counter Mode) using 256-bit keys.", "RSASSA-PSS 2048 bit key with a SHA256 digest.", "RSASSA-PSS 3072 bit key with a SHA256 digest.", "RSASSA-PSS 4096 bit key with a SHA256 digest.", @@ -2803,6 +2819,10 @@ "GOOGLE_SYMMETRIC_ENCRYPTION", "AES_128_GCM", "AES_256_GCM", + "AES_128_CBC", + "AES_256_CBC", + "AES_128_CTR", + "AES_256_CTR", "RSA_SIGN_PSS_2048_SHA256", "RSA_SIGN_PSS_3072_SHA256", "RSA_SIGN_PSS_4096_SHA256", @@ -2836,6 +2856,10 @@ "Creates symmetric encryption keys.", "AES-GCM (Galois Counter Mode) using 128-bit keys.", "AES-GCM (Galois Counter Mode) using 256-bit keys.", + "AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.", + "AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.", + "AES-CTR (Counter Mode) using 128-bit keys.", + "AES-CTR (Counter Mode) using 256-bit keys.", "RSASSA-PSS 2048 bit key with a SHA256 digest.", "RSASSA-PSS 3072 bit key with a SHA256 digest.", "RSASSA-PSS 4096 bit key with a SHA256 digest.", @@ -3397,6 +3421,10 @@ "GOOGLE_SYMMETRIC_ENCRYPTION", "AES_128_GCM", "AES_256_GCM", + "AES_128_CBC", + "AES_256_CBC", + "AES_128_CTR", + "AES_256_CTR", "RSA_SIGN_PSS_2048_SHA256", "RSA_SIGN_PSS_3072_SHA256", "RSA_SIGN_PSS_4096_SHA256", @@ -3430,6 +3458,10 @@ "Creates symmetric encryption keys.", "AES-GCM (Galois Counter Mode) using 128-bit keys.", "AES-GCM (Galois Counter Mode) using 256-bit keys.", + "AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.", + "AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.", + "AES-CTR (Counter Mode) using 128-bit keys.", + "AES-CTR (Counter Mode) using 256-bit keys.", "RSASSA-PSS 2048 bit key with a SHA256 digest.", "RSASSA-PSS 3072 bit key with a SHA256 digest.", "RSASSA-PSS 4096 bit key with a SHA256 digest.", diff --git a/cloudkms/v1/cloudkms-gen.go b/cloudkms/v1/cloudkms-gen.go index 0d9c973e190..6f43807fd56 100644 --- a/cloudkms/v1/cloudkms-gen.go +++ b/cloudkms/v1/cloudkms-gen.go @@ -913,6 +913,12 @@ type CryptoKeyVersion struct { // "GOOGLE_SYMMETRIC_ENCRYPTION" - Creates symmetric encryption keys. // "AES_128_GCM" - AES-GCM (Galois Counter Mode) using 128-bit keys. // "AES_256_GCM" - AES-GCM (Galois Counter Mode) using 256-bit keys. + // "AES_128_CBC" - AES-CBC (Cipher Block Chaining Mode) using 128-bit + // keys. + // "AES_256_CBC" - AES-CBC (Cipher Block Chaining Mode) using 256-bit + // keys. + // "AES_128_CTR" - AES-CTR (Counter Mode) using 128-bit keys. + // "AES_256_CTR" - AES-CTR (Counter Mode) using 256-bit keys. // "RSA_SIGN_PSS_2048_SHA256" - RSASSA-PSS 2048 bit key with a SHA256 // digest. // "RSA_SIGN_PSS_3072_SHA256" - RSASSA-PSS 3072 bit key with a SHA256 @@ -1128,6 +1134,12 @@ type CryptoKeyVersionTemplate struct { // "GOOGLE_SYMMETRIC_ENCRYPTION" - Creates symmetric encryption keys. // "AES_128_GCM" - AES-GCM (Galois Counter Mode) using 128-bit keys. // "AES_256_GCM" - AES-GCM (Galois Counter Mode) using 256-bit keys. + // "AES_128_CBC" - AES-CBC (Cipher Block Chaining Mode) using 128-bit + // keys. + // "AES_256_CBC" - AES-CBC (Cipher Block Chaining Mode) using 256-bit + // keys. + // "AES_128_CTR" - AES-CTR (Counter Mode) using 128-bit keys. + // "AES_256_CTR" - AES-CTR (Counter Mode) using 256-bit keys. // "RSA_SIGN_PSS_2048_SHA256" - RSASSA-PSS 2048 bit key with a SHA256 // digest. // "RSA_SIGN_PSS_3072_SHA256" - RSASSA-PSS 3072 bit key with a SHA256 @@ -1880,6 +1892,12 @@ type ImportCryptoKeyVersionRequest struct { // "GOOGLE_SYMMETRIC_ENCRYPTION" - Creates symmetric encryption keys. // "AES_128_GCM" - AES-GCM (Galois Counter Mode) using 128-bit keys. // "AES_256_GCM" - AES-GCM (Galois Counter Mode) using 256-bit keys. + // "AES_128_CBC" - AES-CBC (Cipher Block Chaining Mode) using 128-bit + // keys. + // "AES_256_CBC" - AES-CBC (Cipher Block Chaining Mode) using 256-bit + // keys. + // "AES_128_CTR" - AES-CTR (Counter Mode) using 128-bit keys. + // "AES_256_CTR" - AES-CTR (Counter Mode) using 256-bit keys. // "RSA_SIGN_PSS_2048_SHA256" - RSASSA-PSS 2048 bit key with a SHA256 // digest. // "RSA_SIGN_PSS_3072_SHA256" - RSASSA-PSS 3072 bit key with a SHA256 @@ -2943,6 +2961,12 @@ type PublicKey struct { // "GOOGLE_SYMMETRIC_ENCRYPTION" - Creates symmetric encryption keys. // "AES_128_GCM" - AES-GCM (Galois Counter Mode) using 128-bit keys. // "AES_256_GCM" - AES-GCM (Galois Counter Mode) using 256-bit keys. + // "AES_128_CBC" - AES-CBC (Cipher Block Chaining Mode) using 128-bit + // keys. + // "AES_256_CBC" - AES-CBC (Cipher Block Chaining Mode) using 256-bit + // keys. + // "AES_128_CTR" - AES-CTR (Counter Mode) using 128-bit keys. + // "AES_256_CTR" - AES-CTR (Counter Mode) using 256-bit keys. // "RSA_SIGN_PSS_2048_SHA256" - RSASSA-PSS 2048 bit key with a SHA256 // digest. // "RSA_SIGN_PSS_3072_SHA256" - RSASSA-PSS 3072 bit key with a SHA256 diff --git a/compute/v0.alpha/compute-api.json b/compute/v0.alpha/compute-api.json index 4a3b7af37dd..6610a4ddafe 100644 --- a/compute/v0.alpha/compute-api.json +++ b/compute/v0.alpha/compute-api.json @@ -21533,6 +21533,40 @@ "https://www.googleapis.com/auth/compute" ] }, + "setManagedProtectionTier": { + "description": "Sets the Cloud Armor Managed Protection (CAMP) tier of the project. To set PLUS or above the billing account of the project must be subscribed to Managed Protection Plus. See Subscribing to Managed Protection Plus for more information.", + "flatPath": "projects/{project}/setManagedProtectionTier", + "httpMethod": "POST", + "id": "compute.projects.setManagedProtectionTier", + "parameterOrder": [ + "project" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/setManagedProtectionTier", + "request": { + "$ref": "ProjectsSetManagedProtectionTierRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "setUsageExportBucket": { "description": "Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.", "flatPath": "projects/{project}/setUsageExportBucket", @@ -29734,7 +29768,7 @@ ] }, "patch": { - "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "httpMethod": "PATCH", "id": "compute.regionSecurityPolicies.patch", @@ -34203,7 +34237,7 @@ ] }, "patch": { - "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}", "httpMethod": "PATCH", "id": "compute.securityPolicies.patch", @@ -34256,7 +34290,7 @@ ] }, "patchRule": { - "description": "Patches a rule at the specified priority.", + "description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule", "httpMethod": "POST", "id": "compute.securityPolicies.patchRule", @@ -42087,7 +42121,7 @@ } } }, - "revision": "20230701", + "revision": "20230711", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -44962,7 +44996,7 @@ "type": "string" }, "customResponseHeaders": { - "description": "Headers that the HTTP/S load balancer should add to proxied responses.", + "description": "Headers that the Application Load Balancer should add to proxied responses.", "items": { "type": "string" }, @@ -57554,14 +57588,14 @@ "type": "string" }, "type": { - "description": "The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).", + "description": "The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update.", "enum": [ "OPPORTUNISTIC", "PROACTIVE" ], "enumDescriptions": [ - "No action is being proactively performed in order to bring this IGM to its target version distribution (regardless of whether this distribution is expressed using instanceTemplate or versions field).", - "This IGM will actively converge to its target version distribution (regardless of whether this distribution is expressed using instanceTemplate or versions field)." + "MIG will apply new configurations to existing VMs only when you selectively target specific or all VMs to be updated.", + "MIG will automatically apply new configurations to all or a subset of existing VMs and also to new VMs that are added to the group." ], "type": "string" } @@ -72352,6 +72386,20 @@ "description": "[Output Only] Type of the resource. Always compute#project for projects.", "type": "string" }, + "managedProtectionTier": { + "description": "[Output Only] The Cloud Armor Managed Protection (CAMP) tier for this project. It can be one of the following values: CA_STANDARD, CAMP_PLUS_MONTHLY. If this field is not specified, it is assumed to be CA_STANDARD.", + "enum": [ + "CAMP_PLUS_ANNUAL", + "CAMP_PLUS_MONTHLY", + "CA_STANDARD" + ], + "enumDescriptions": [ + "Plus tier protection annual.", + "Plus tier protection monthly.", + "Standard protection." + ], + "type": "string" + }, "name": { "description": "The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.", "type": "string" @@ -72492,6 +72540,26 @@ }, "type": "object" }, + "ProjectsSetManagedProtectionTierRequest": { + "id": "ProjectsSetManagedProtectionTierRequest", + "properties": { + "managedProtectionTier": { + "description": "Managed protection tier to be set.", + "enum": [ + "CAMP_PLUS_ANNUAL", + "CAMP_PLUS_MONTHLY", + "CA_STANDARD" + ], + "enumDescriptions": [ + "Plus tier protection annual.", + "Plus tier protection monthly.", + "Standard protection." + ], + "type": "string" + } + }, + "type": "object" + }, "PublicAdvertisedPrefix": { "description": "A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.", "id": "PublicAdvertisedPrefix", @@ -76258,6 +76326,7 @@ "NO_RESERVATION", "SPECIFIC_RESERVATION", "SPECIFIC_THEN_ANY_RESERVATION", + "SPECIFIC_THEN_NO_RESERVATION", "UNSPECIFIED" ], "enumDescriptions": [ @@ -76265,6 +76334,7 @@ "Do not consume from any allocated capacity.", "Must consume from a specific reservation. Must specify key value fields for specifying the reservations.", "Prefer to consume from a specific reservation, but still consume any reservation available if the specified reservation is not available or exhausted. Must specify key value fields for specifying the reservations.", + "Prefer to consume from a specific reservation, but still consume from the on-demand pool if the specified reservation is exhausted. Must specify key value fields for specifying the reservations.", "" ], "type": "string" diff --git a/compute/v0.alpha/compute-gen.go b/compute/v0.alpha/compute-gen.go index ba6698123b0..03c1e8bcaab 100644 --- a/compute/v0.alpha/compute-gen.go +++ b/compute/v0.alpha/compute-gen.go @@ -5525,8 +5525,8 @@ type BackendBucket struct { // format. CreationTimestamp string `json:"creationTimestamp,omitempty"` - // CustomResponseHeaders: Headers that the HTTP/S load balancer should - // add to proxied responses. + // CustomResponseHeaders: Headers that the Application Load Balancer + // should add to proxied responses. CustomResponseHeaders []string `json:"customResponseHeaders,omitempty"` // Description: An optional textual description of the resource; @@ -23820,20 +23820,16 @@ type InstanceGroupManagerUpdatePolicy struct { ReplacementMethod string `json:"replacementMethod,omitempty"` // Type: The type of update process. You can specify either PROACTIVE so - // that the instance group manager proactively executes actions in order - // to bring instances to their target versions or OPPORTUNISTIC so that - // no action is proactively executed but the update will be performed as - // part of other actions (for example, resizes or recreateInstances - // calls). - // - // Possible values: - // "OPPORTUNISTIC" - No action is being proactively performed in order - // to bring this IGM to its target version distribution (regardless of - // whether this distribution is expressed using instanceTemplate or - // versions field). - // "PROACTIVE" - This IGM will actively converge to its target version - // distribution (regardless of whether this distribution is expressed - // using instanceTemplate or versions field). + // that the MIG automatically updates VMs to the latest configurations + // or OPPORTUNISTIC so that you can select the VMs that you want to + // update. + // + // Possible values: + // "OPPORTUNISTIC" - MIG will apply new configurations to existing VMs + // only when you selectively target specific or all VMs to be updated. + // "PROACTIVE" - MIG will automatically apply new configurations to + // all or a subset of existing VMs and also to new VMs that are added to + // the group. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -44494,6 +44490,17 @@ type Project struct { // projects. Kind string `json:"kind,omitempty"` + // ManagedProtectionTier: [Output Only] The Cloud Armor Managed + // Protection (CAMP) tier for this project. It can be one of the + // following values: CA_STANDARD, CAMP_PLUS_MONTHLY. If this field is + // not specified, it is assumed to be CA_STANDARD. + // + // Possible values: + // "CAMP_PLUS_ANNUAL" - Plus tier protection annual. + // "CAMP_PLUS_MONTHLY" - Plus tier protection monthly. + // "CA_STANDARD" - Standard protection. + ManagedProtectionTier string `json:"managedProtectionTier,omitempty"` + // Name: The project ID. For example: my-example-project. Use the // project ID to make requests to Compute Engine. Name string `json:"name,omitempty"` @@ -44758,6 +44765,40 @@ func (s *ProjectsSetDefaultServiceAccountRequest) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type ProjectsSetManagedProtectionTierRequest struct { + // ManagedProtectionTier: Managed protection tier to be set. + // + // Possible values: + // "CAMP_PLUS_ANNUAL" - Plus tier protection annual. + // "CAMP_PLUS_MONTHLY" - Plus tier protection monthly. + // "CA_STANDARD" - Standard protection. + ManagedProtectionTier string `json:"managedProtectionTier,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ManagedProtectionTier") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ManagedProtectionTier") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *ProjectsSetManagedProtectionTierRequest) MarshalJSON() ([]byte, error) { + type NoMethod ProjectsSetManagedProtectionTierRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // PublicAdvertisedPrefix: A public advertised prefix represents an // aggregated IP prefix or netblock which customers bring to cloud. The // IP prefix is a single unit of route advertisement and is announced @@ -49873,6 +49914,10 @@ type ReservationAffinity struct { // reservation, but still consume any reservation available if the // specified reservation is not available or exhausted. Must specify key // value fields for specifying the reservations. + // "SPECIFIC_THEN_NO_RESERVATION" - Prefer to consume from a specific + // reservation, but still consume from the on-demand pool if the + // specified reservation is exhausted. Must specify key value fields for + // specifying the reservations. // "UNSPECIFIED" ConsumeReservationType string `json:"consumeReservationType,omitempty"` @@ -164269,6 +164314,173 @@ func (c *ProjectsSetDefaultServiceAccountCall) Do(opts ...googleapi.CallOption) } +// method id "compute.projects.setManagedProtectionTier": + +type ProjectsSetManagedProtectionTierCall struct { + s *Service + project string + projectssetmanagedprotectiontierrequest *ProjectsSetManagedProtectionTierRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// SetManagedProtectionTier: Sets the Cloud Armor Managed Protection +// (CAMP) tier of the project. To set PLUS or above the billing account +// of the project must be subscribed to Managed Protection Plus. See +// Subscribing to Managed Protection Plus for more information. +// +// - project: Project ID for this request. +func (r *ProjectsService) SetManagedProtectionTier(project string, projectssetmanagedprotectiontierrequest *ProjectsSetManagedProtectionTierRequest) *ProjectsSetManagedProtectionTierCall { + c := &ProjectsSetManagedProtectionTierCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.project = project + c.projectssetmanagedprotectiontierrequest = projectssetmanagedprotectiontierrequest + return c +} + +// RequestId sets the optional parameter "requestId": An optional +// request ID to identify requests. Specify a unique request ID so that +// if you must retry your request, the server will know to ignore the +// request if it has already been completed. For example, consider a +// situation where you make an initial request and the request times +// out. If you make the request again with the same request ID, the +// server can check if original operation with the same request ID was +// received, and if so, will ignore the second request. This prevents +// clients from accidentally creating duplicate commitments. The request +// ID must be a valid UUID with the exception that zero UUID is not +// supported ( 00000000-0000-0000-0000-000000000000). +func (c *ProjectsSetManagedProtectionTierCall) RequestId(requestId string) *ProjectsSetManagedProtectionTierCall { + c.urlParams_.Set("requestId", requestId) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsSetManagedProtectionTierCall) Fields(s ...googleapi.Field) *ProjectsSetManagedProtectionTierCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsSetManagedProtectionTierCall) Context(ctx context.Context) *ProjectsSetManagedProtectionTierCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsSetManagedProtectionTierCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsSetManagedProtectionTierCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.projectssetmanagedprotectiontierrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{project}/setManagedProtectionTier") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "project": c.project, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "compute.projects.setManagedProtectionTier" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsSetManagedProtectionTierCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Sets the Cloud Armor Managed Protection (CAMP) tier of the project. To set PLUS or above the billing account of the project must be subscribed to Managed Protection Plus. See Subscribing to Managed Protection Plus for more information.", + // "flatPath": "projects/{project}/setManagedProtectionTier", + // "httpMethod": "POST", + // "id": "compute.projects.setManagedProtectionTier", + // "parameterOrder": [ + // "project" + // ], + // "parameters": { + // "project": { + // "description": "Project ID for this request.", + // "location": "path", + // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + // "required": true, + // "type": "string" + // }, + // "requestId": { + // "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "projects/{project}/setManagedProtectionTier", + // "request": { + // "$ref": "ProjectsSetManagedProtectionTierRequest" + // }, + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform", + // "https://www.googleapis.com/auth/compute" + // ] + // } + +} + // method id "compute.projects.setUsageExportBucket": type ProjectsSetUsageExportBucketCall struct { @@ -197298,7 +197510,7 @@ type RegionSecurityPoliciesPatchCall struct { } // Patch: Patches the specified policy with the data included in the -// request. To clear fields in the rule, leave the fields empty and +// request. To clear fields in the policy, leave the fields empty and // specify them in the updateMask. This cannot be used to be update the // rules in the policy. Please use the per rule methods like addRule, // patchRule, and removeRule instead. @@ -197437,7 +197649,7 @@ func (c *RegionSecurityPoliciesPatchCall) Do(opts ...googleapi.CallOption) (*Ope } return ret, nil // { - // "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + // "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", // "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", // "httpMethod": "PATCH", // "id": "compute.regionSecurityPolicies.patch", @@ -215501,7 +215713,7 @@ type SecurityPoliciesPatchCall struct { } // Patch: Patches the specified policy with the data included in the -// request. To clear fields in the rule, leave the fields empty and +// request. To clear fields in the policy, leave the fields empty and // specify them in the updateMask. This cannot be used to be update the // rules in the policy. Please use the per rule methods like addRule, // patchRule, and removeRule instead. @@ -215637,7 +215849,7 @@ func (c *SecurityPoliciesPatchCall) Do(opts ...googleapi.CallOption) (*Operation } return ret, nil // { - // "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + // "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", // "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}", // "httpMethod": "PATCH", // "id": "compute.securityPolicies.patch", @@ -215704,7 +215916,9 @@ type SecurityPoliciesPatchRuleCall struct { header_ http.Header } -// PatchRule: Patches a rule at the specified priority. +// PatchRule: Patches a rule at the specified priority. To clear fields +// in the rule, leave the fields empty and specify them in the +// updateMask. // // - project: Project ID for this request. // - securityPolicy: Name of the security policy to update. @@ -215829,7 +216043,7 @@ func (c *SecurityPoliciesPatchRuleCall) Do(opts ...googleapi.CallOption) (*Opera } return ret, nil // { - // "description": "Patches a rule at the specified priority.", + // "description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", // "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule", // "httpMethod": "POST", // "id": "compute.securityPolicies.patchRule", diff --git a/compute/v0.beta/compute-api.json b/compute/v0.beta/compute-api.json index c661a37192c..e8a2fe1d3c8 100644 --- a/compute/v0.beta/compute-api.json +++ b/compute/v0.beta/compute-api.json @@ -19838,6 +19838,40 @@ "https://www.googleapis.com/auth/compute" ] }, + "setManagedProtectionTier": { + "description": "Sets the Cloud Armor Managed Protection (CAMP) tier of the project. To set PLUS or above the billing account of the project must be subscribed to Managed Protection Plus. See Subscribing to Managed Protection Plus for more information.", + "flatPath": "projects/{project}/setManagedProtectionTier", + "httpMethod": "POST", + "id": "compute.projects.setManagedProtectionTier", + "parameterOrder": [ + "project" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/setManagedProtectionTier", + "request": { + "$ref": "ProjectsSetManagedProtectionTierRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "setUsageExportBucket": { "description": "Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.", "flatPath": "projects/{project}/setUsageExportBucket", @@ -27245,7 +27279,7 @@ ] }, "patch": { - "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "httpMethod": "PATCH", "id": "compute.regionSecurityPolicies.patch", @@ -29387,6 +29421,73 @@ } } }, + "regionZones": { + "methods": { + "list": { + "description": "Retrieves the list of Zone resources under the specific region available to the specified project.", + "flatPath": "projects/{project}/regions/{region}/zones", + "httpMethod": "GET", + "id": "compute.regionZones.list", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/regions/{region}/zones", + "response": { + "$ref": "ZoneList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "regions": { "methods": { "get": { @@ -31590,7 +31691,7 @@ ] }, "patch": { - "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}", "httpMethod": "PATCH", "id": "compute.securityPolicies.patch", @@ -31638,7 +31739,7 @@ ] }, "patchRule": { - "description": "Patches a rule at the specified priority.", + "description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule", "httpMethod": "POST", "id": "compute.securityPolicies.patchRule", @@ -38519,7 +38620,7 @@ } } }, - "revision": "20230701", + "revision": "20230711", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -41177,7 +41278,7 @@ "type": "string" }, "customResponseHeaders": { - "description": "Headers that the HTTP/S load balancer should add to proxied responses.", + "description": "Headers that the Application Load Balancer should add to proxied responses.", "items": { "type": "string" }, @@ -51704,6 +51805,7 @@ "description": "[Output only] Current state of the request.", "enum": [ "ACCEPTED", + "CANCELLED", "CREATING", "FAILED", "PROVISIONING", @@ -51711,6 +51813,7 @@ ], "enumDescriptions": [ "The request was created successfully and was accepted for provisioning when the capacity becomes available.", + "The request is cancelled.", "resize request is being created and may still fail creation.", "The request failed before or during provisioning. If the request fails during provisioning, any VMs that were created during provisioning are rolled back and removed from the MIG.", "The target resource(s) are being provisioned.", @@ -52087,14 +52190,14 @@ "type": "string" }, "type": { - "description": "The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).", + "description": "The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update.", "enum": [ "OPPORTUNISTIC", "PROACTIVE" ], "enumDescriptions": [ - "No action is being proactively performed in order to bring this IGM to its target version distribution (regardless of whether this distribution is expressed using instanceTemplate or versions field).", - "This IGM will actively converge to its target version distribution (regardless of whether this distribution is expressed using instanceTemplate or versions field)." + "MIG will apply new configurations to existing VMs only when you selectively target specific or all VMs to be updated.", + "MIG will automatically apply new configurations to all or a subset of existing VMs and also to new VMs that are added to the group." ], "type": "string" } @@ -65394,6 +65497,20 @@ "description": "[Output Only] Type of the resource. Always compute#project for projects.", "type": "string" }, + "managedProtectionTier": { + "description": "[Output Only] The Cloud Armor Managed Protection (CAMP) tier for this project. It can be one of the following values: CA_STANDARD, CAMP_PLUS_MONTHLY. If this field is not specified, it is assumed to be CA_STANDARD.", + "enum": [ + "CAMP_PLUS_ANNUAL", + "CAMP_PLUS_MONTHLY", + "CA_STANDARD" + ], + "enumDescriptions": [ + "Plus tier protection annual.", + "Plus tier protection monthly.", + "Standard protection." + ], + "type": "string" + }, "name": { "description": "The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.", "type": "string" @@ -65518,6 +65635,26 @@ }, "type": "object" }, + "ProjectsSetManagedProtectionTierRequest": { + "id": "ProjectsSetManagedProtectionTierRequest", + "properties": { + "managedProtectionTier": { + "description": "Managed protection tier to be set.", + "enum": [ + "CAMP_PLUS_ANNUAL", + "CAMP_PLUS_MONTHLY", + "CA_STANDARD" + ], + "enumDescriptions": [ + "Plus tier protection annual.", + "Plus tier protection monthly.", + "Standard protection." + ], + "type": "string" + } + }, + "type": "object" + }, "PublicAdvertisedPrefix": { "description": "A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.", "id": "PublicAdvertisedPrefix", @@ -66691,6 +66828,11 @@ "description": "The map holding related quota dimensions.", "type": "object" }, + "futureLimit": { + "description": "Future quota limit being rolled out. The limit's unit depends on the quota type or metric.", + "format": "double", + "type": "number" + }, "limit": { "description": "Current effective quota limit. The limit's unit depends on the quota type or metric.", "format": "double", @@ -66703,6 +66845,18 @@ "metricName": { "description": "The Compute Engine quota metric name.", "type": "string" + }, + "rolloutStatus": { + "description": "Rollout status of the future quota limit.", + "enum": [ + "IN_PROGRESS", + "ROLLOUT_STATUS_UNSPECIFIED" + ], + "enumDescriptions": [ + "IN_PROGRESS - A rollout is in process which will change the limit value to future limit.", + "ROLLOUT_STATUS_UNSPECIFIED - Rollout status is not specified. The default value." + ], + "type": "string" } }, "type": "object" @@ -72017,6 +72171,10 @@ ], "type": "string" }, + "localSsdRecoveryTimeout": { + "$ref": "Duration", + "description": "Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour." + }, "locationHint": { "description": "An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.", "type": "string" @@ -73898,6 +74056,10 @@ "description": "[Output Only] A connection connected to this service attachment.", "id": "ServiceAttachmentConnectedEndpoint", "properties": { + "consumerNetwork": { + "description": "The url of the consumer network.", + "type": "string" + }, "endpoint": { "description": "The url of a connected endpoint.", "type": "string" diff --git a/compute/v0.beta/compute-gen.go b/compute/v0.beta/compute-gen.go index a47c63c2ac2..73d2223e18e 100644 --- a/compute/v0.beta/compute-gen.go +++ b/compute/v0.beta/compute-gen.go @@ -217,6 +217,7 @@ func New(client *http.Client) (*Service, error) { s.RegionTargetHttpsProxies = NewRegionTargetHttpsProxiesService(s) s.RegionTargetTcpProxies = NewRegionTargetTcpProxiesService(s) s.RegionUrlMaps = NewRegionUrlMapsService(s) + s.RegionZones = NewRegionZonesService(s) s.Regions = NewRegionsService(s) s.Reservations = NewReservationsService(s) s.ResourcePolicies = NewResourcePoliciesService(s) @@ -393,6 +394,8 @@ type Service struct { RegionUrlMaps *RegionUrlMapsService + RegionZones *RegionZonesService + Regions *RegionsService Reservations *ReservationsService @@ -1097,6 +1100,15 @@ type RegionUrlMapsService struct { s *Service } +func NewRegionZonesService(s *Service) *RegionZonesService { + rs := &RegionZonesService{s: s} + return rs +} + +type RegionZonesService struct { + s *Service +} + func NewRegionsService(s *Service) *RegionsService { rs := &RegionsService{s: s} return rs @@ -5140,8 +5152,8 @@ type BackendBucket struct { // format. CreationTimestamp string `json:"creationTimestamp,omitempty"` - // CustomResponseHeaders: Headers that the HTTP/S load balancer should - // add to proxied responses. + // CustomResponseHeaders: Headers that the Application Load Balancer + // should add to proxied responses. CustomResponseHeaders []string `json:"customResponseHeaders,omitempty"` // Description: An optional textual description of the resource; @@ -20464,6 +20476,7 @@ type InstanceGroupManagerResizeRequest struct { // Possible values: // "ACCEPTED" - The request was created successfully and was accepted // for provisioning when the capacity becomes available. + // "CANCELLED" - The request is cancelled. // "CREATING" - resize request is being created and may still fail // creation. // "FAILED" - The request failed before or during provisioning. If the @@ -21119,20 +21132,16 @@ type InstanceGroupManagerUpdatePolicy struct { ReplacementMethod string `json:"replacementMethod,omitempty"` // Type: The type of update process. You can specify either PROACTIVE so - // that the instance group manager proactively executes actions in order - // to bring instances to their target versions or OPPORTUNISTIC so that - // no action is proactively executed but the update will be performed as - // part of other actions (for example, resizes or recreateInstances - // calls). + // that the MIG automatically updates VMs to the latest configurations + // or OPPORTUNISTIC so that you can select the VMs that you want to + // update. // // Possible values: - // "OPPORTUNISTIC" - No action is being proactively performed in order - // to bring this IGM to its target version distribution (regardless of - // whether this distribution is expressed using instanceTemplate or - // versions field). - // "PROACTIVE" - This IGM will actively converge to its target version - // distribution (regardless of whether this distribution is expressed - // using instanceTemplate or versions field). + // "OPPORTUNISTIC" - MIG will apply new configurations to existing VMs + // only when you selectively target specific or all VMs to be updated. + // "PROACTIVE" - MIG will automatically apply new configurations to + // all or a subset of existing VMs and also to new VMs that are added to + // the group. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -39802,6 +39811,17 @@ type Project struct { // projects. Kind string `json:"kind,omitempty"` + // ManagedProtectionTier: [Output Only] The Cloud Armor Managed + // Protection (CAMP) tier for this project. It can be one of the + // following values: CA_STANDARD, CAMP_PLUS_MONTHLY. If this field is + // not specified, it is assumed to be CA_STANDARD. + // + // Possible values: + // "CAMP_PLUS_ANNUAL" - Plus tier protection annual. + // "CAMP_PLUS_MONTHLY" - Plus tier protection monthly. + // "CA_STANDARD" - Standard protection. + ManagedProtectionTier string `json:"managedProtectionTier,omitempty"` + // Name: The project ID. For example: my-example-project. Use the // project ID to make requests to Compute Engine. Name string `json:"name,omitempty"` @@ -40029,6 +40049,40 @@ func (s *ProjectsSetDefaultNetworkTierRequest) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type ProjectsSetManagedProtectionTierRequest struct { + // ManagedProtectionTier: Managed protection tier to be set. + // + // Possible values: + // "CAMP_PLUS_ANNUAL" - Plus tier protection annual. + // "CAMP_PLUS_MONTHLY" - Plus tier protection monthly. + // "CA_STANDARD" - Standard protection. + ManagedProtectionTier string `json:"managedProtectionTier,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ManagedProtectionTier") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ManagedProtectionTier") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *ProjectsSetManagedProtectionTierRequest) MarshalJSON() ([]byte, error) { + type NoMethod ProjectsSetManagedProtectionTierRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // PublicAdvertisedPrefix: A public advertised prefix represents an // aggregated IP prefix or netblock which customers bring to cloud. The // IP prefix is a single unit of route advertisement and is announced @@ -41314,6 +41368,10 @@ type QuotaExceededInfo struct { // Dimensions: The map holding related quota dimensions. Dimensions map[string]string `json:"dimensions,omitempty"` + // FutureLimit: Future quota limit being rolled out. The limit's unit + // depends on the quota type or metric. + FutureLimit float64 `json:"futureLimit,omitempty"` + // Limit: Current effective quota limit. The limit's unit depends on the // quota type or metric. Limit float64 `json:"limit,omitempty"` @@ -41324,6 +41382,15 @@ type QuotaExceededInfo struct { // MetricName: The Compute Engine quota metric name. MetricName string `json:"metricName,omitempty"` + // RolloutStatus: Rollout status of the future quota limit. + // + // Possible values: + // "IN_PROGRESS" - IN_PROGRESS - A rollout is in process which will + // change the limit value to future limit. + // "ROLLOUT_STATUS_UNSPECIFIED" - ROLLOUT_STATUS_UNSPECIFIED - Rollout + // status is not specified. The default value. + RolloutStatus string `json:"rolloutStatus,omitempty"` + // ForceSendFields is a list of field names (e.g. "Dimensions") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -41350,13 +41417,15 @@ func (s *QuotaExceededInfo) MarshalJSON() ([]byte, error) { func (s *QuotaExceededInfo) UnmarshalJSON(data []byte) error { type NoMethod QuotaExceededInfo var s1 struct { - Limit gensupport.JSONFloat64 `json:"limit"` + FutureLimit gensupport.JSONFloat64 `json:"futureLimit"` + Limit gensupport.JSONFloat64 `json:"limit"` *NoMethod } s1.NoMethod = (*NoMethod)(s) if err := json.Unmarshal(data, &s1); err != nil { return err } + s.FutureLimit = float64(s1.FutureLimit) s.Limit = float64(s1.Limit) return nil } @@ -48661,6 +48730,12 @@ type Scheduling struct { // action. InstanceTerminationAction string `json:"instanceTerminationAction,omitempty"` + // LocalSsdRecoveryTimeout: Specifies the maximum amount of time a Local + // Ssd Vm should wait while recovery of the Local Ssd state is + // attempted. Its value should be in between 0 and 168 hours with hour + // granularity and the default value being 1 hour. + LocalSsdRecoveryTimeout *Duration `json:"localSsdRecoveryTimeout,omitempty"` + // LocationHint: An opaque location hint used to place the instance // close to other resources. This field is for use by internal tools // that use the public API. @@ -51449,6 +51524,9 @@ func (s *ServiceAttachmentAggregatedListWarningData) MarshalJSON() ([]byte, erro // ServiceAttachmentConnectedEndpoint: [Output Only] A connection // connected to this service attachment. type ServiceAttachmentConnectedEndpoint struct { + // ConsumerNetwork: The url of the consumer network. + ConsumerNetwork string `json:"consumerNetwork,omitempty"` + // Endpoint: The url of a connected endpoint. Endpoint string `json:"endpoint,omitempty"` @@ -51470,7 +51548,7 @@ type ServiceAttachmentConnectedEndpoint struct { // "STATUS_UNSPECIFIED" Status string `json:"status,omitempty"` - // ForceSendFields is a list of field names (e.g. "Endpoint") to + // ForceSendFields is a list of field names (e.g. "ConsumerNetwork") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -51478,12 +51556,13 @@ type ServiceAttachmentConnectedEndpoint struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Endpoint") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "ConsumerNetwork") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. NullFields []string `json:"-"` } @@ -149174,6 +149253,173 @@ func (c *ProjectsSetDefaultNetworkTierCall) Do(opts ...googleapi.CallOption) (*O } +// method id "compute.projects.setManagedProtectionTier": + +type ProjectsSetManagedProtectionTierCall struct { + s *Service + project string + projectssetmanagedprotectiontierrequest *ProjectsSetManagedProtectionTierRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// SetManagedProtectionTier: Sets the Cloud Armor Managed Protection +// (CAMP) tier of the project. To set PLUS or above the billing account +// of the project must be subscribed to Managed Protection Plus. See +// Subscribing to Managed Protection Plus for more information. +// +// - project: Project ID for this request. +func (r *ProjectsService) SetManagedProtectionTier(project string, projectssetmanagedprotectiontierrequest *ProjectsSetManagedProtectionTierRequest) *ProjectsSetManagedProtectionTierCall { + c := &ProjectsSetManagedProtectionTierCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.project = project + c.projectssetmanagedprotectiontierrequest = projectssetmanagedprotectiontierrequest + return c +} + +// RequestId sets the optional parameter "requestId": An optional +// request ID to identify requests. Specify a unique request ID so that +// if you must retry your request, the server will know to ignore the +// request if it has already been completed. For example, consider a +// situation where you make an initial request and the request times +// out. If you make the request again with the same request ID, the +// server can check if original operation with the same request ID was +// received, and if so, will ignore the second request. This prevents +// clients from accidentally creating duplicate commitments. The request +// ID must be a valid UUID with the exception that zero UUID is not +// supported ( 00000000-0000-0000-0000-000000000000). +func (c *ProjectsSetManagedProtectionTierCall) RequestId(requestId string) *ProjectsSetManagedProtectionTierCall { + c.urlParams_.Set("requestId", requestId) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsSetManagedProtectionTierCall) Fields(s ...googleapi.Field) *ProjectsSetManagedProtectionTierCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsSetManagedProtectionTierCall) Context(ctx context.Context) *ProjectsSetManagedProtectionTierCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsSetManagedProtectionTierCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsSetManagedProtectionTierCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.projectssetmanagedprotectiontierrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{project}/setManagedProtectionTier") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "project": c.project, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "compute.projects.setManagedProtectionTier" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsSetManagedProtectionTierCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Sets the Cloud Armor Managed Protection (CAMP) tier of the project. To set PLUS or above the billing account of the project must be subscribed to Managed Protection Plus. See Subscribing to Managed Protection Plus for more information.", + // "flatPath": "projects/{project}/setManagedProtectionTier", + // "httpMethod": "POST", + // "id": "compute.projects.setManagedProtectionTier", + // "parameterOrder": [ + // "project" + // ], + // "parameters": { + // "project": { + // "description": "Project ID for this request.", + // "location": "path", + // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + // "required": true, + // "type": "string" + // }, + // "requestId": { + // "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "projects/{project}/setManagedProtectionTier", + // "request": { + // "$ref": "ProjectsSetManagedProtectionTierRequest" + // }, + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform", + // "https://www.googleapis.com/auth/compute" + // ] + // } + +} + // method id "compute.projects.setUsageExportBucket": type ProjectsSetUsageExportBucketCall struct { @@ -178951,7 +179197,7 @@ type RegionSecurityPoliciesPatchCall struct { } // Patch: Patches the specified policy with the data included in the -// request. To clear fields in the rule, leave the fields empty and +// request. To clear fields in the policy, leave the fields empty and // specify them in the updateMask. This cannot be used to be update the // rules in the policy. Please use the per rule methods like addRule, // patchRule, and removeRule instead. @@ -179084,7 +179330,7 @@ func (c *RegionSecurityPoliciesPatchCall) Do(opts ...googleapi.CallOption) (*Ope } return ret, nil // { - // "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + // "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", // "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", // "httpMethod": "PATCH", // "id": "compute.regionSecurityPolicies.patch", @@ -187366,6 +187612,298 @@ func (c *RegionUrlMapsValidateCall) Do(opts ...googleapi.CallOption) (*UrlMapsVa } +// method id "compute.regionZones.list": + +type RegionZonesListCall struct { + s *Service + project string + region string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: Retrieves the list of Zone resources under the specific region +// available to the specified project. +// +// - project: Project ID for this request. +// - region: Region for this request. +func (r *RegionZonesService) List(project string, region string) *RegionZonesListCall { + c := &RegionZonesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.project = project + c.region = region + return c +} + +// Filter sets the optional parameter "filter": A filter expression that +// filters resources listed in the response. Most Compute resources +// support two types of filter expressions: expressions that support +// regular expressions and expressions that follow API improvement +// proposal AIP-160. If you want to use AIP-160, your expression must +// specify the field name, an operator, and the value that you want to +// use for filtering. The value must be a string, a number, or a +// boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` +// or `:`. For example, if you are filtering Compute Engine instances, +// you can exclude instances named `example-instance` by specifying +// `name != example-instance`. The `:` operator can be used with string +// fields to match substrings. For non-string fields it is equivalent to +// the `=` operator. The `:*` comparison can be used to test whether a +// key has been defined. For example, to find all objects with `owner` +// label use: ``` labels.owner:* ``` You can also filter nested fields. +// For example, you could specify `scheduling.automaticRestart = false` +// to include instances only if they are not scheduled for automatic +// restarts. You can use filtering on nested fields to filter based on +// resource labels. To filter on multiple expressions, provide each +// separate expression within parentheses. For example: ``` +// (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") +// ``` By default, each expression is an `AND` expression. However, you +// can include `AND` and `OR` expressions explicitly. For example: ``` +// (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") +// AND (scheduling.automaticRestart = true) ``` If you want to use a +// regular expression, use the `eq` (equal) or `ne` (not equal) operator +// against a single un-parenthesized expression with or without quotes +// or against multiple parenthesized expressions. Examples: `fieldname +// eq unquoted literal` `fieldname eq 'single quoted literal'` +// `fieldname eq "double quoted literal" `(fieldname1 eq literal) +// (fieldname2 ne "literal")` The literal value is interpreted as a +// regular expression using Google RE2 library syntax. The literal value +// must match the entire field. For example, to filter for instances +// that do not end with name "instance", you would use `name ne +// .*instance`. +func (c *RegionZonesListCall) Filter(filter string) *RegionZonesListCall { + c.urlParams_.Set("filter", filter) + return c +} + +// MaxResults sets the optional parameter "maxResults": The maximum +// number of results per page that should be returned. If the number of +// available results is larger than `maxResults`, Compute Engine returns +// a `nextPageToken` that can be used to get the next page of results in +// subsequent list requests. Acceptable values are `0` to `500`, +// inclusive. (Default: `500`) +func (c *RegionZonesListCall) MaxResults(maxResults int64) *RegionZonesListCall { + c.urlParams_.Set("maxResults", fmt.Sprint(maxResults)) + return c +} + +// OrderBy sets the optional parameter "orderBy": Sorts list results by +// a certain order. By default, results are returned in alphanumerical +// order based on the resource name. You can also sort results in +// descending order based on the creation timestamp using +// `orderBy="creationTimestamp desc". This sorts results based on the +// `creationTimestamp` field in reverse chronological order (newest +// result first). Use this to sort resources like operations so that the +// newest operation is returned first. Currently, only sorting by `name` +// or `creationTimestamp desc` is supported. +func (c *RegionZonesListCall) OrderBy(orderBy string) *RegionZonesListCall { + c.urlParams_.Set("orderBy", orderBy) + return c +} + +// PageToken sets the optional parameter "pageToken": Specifies a page +// token to use. Set `pageToken` to the `nextPageToken` returned by a +// previous list request to get the next page of results. +func (c *RegionZonesListCall) PageToken(pageToken string) *RegionZonesListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// ReturnPartialSuccess sets the optional parameter +// "returnPartialSuccess": Opt-in for partial success behavior which +// provides partial results in case of failure. The default value is +// false. +func (c *RegionZonesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionZonesListCall { + c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *RegionZonesListCall) Fields(s ...googleapi.Field) *RegionZonesListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *RegionZonesListCall) IfNoneMatch(entityTag string) *RegionZonesListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *RegionZonesListCall) Context(ctx context.Context) *RegionZonesListCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *RegionZonesListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *RegionZonesListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{project}/regions/{region}/zones") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "project": c.project, + "region": c.region, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "compute.regionZones.list" call. +// Exactly one of *ZoneList or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *ZoneList.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *RegionZonesListCall) Do(opts ...googleapi.CallOption) (*ZoneList, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ZoneList{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Retrieves the list of Zone resources under the specific region available to the specified project.", + // "flatPath": "projects/{project}/regions/{region}/zones", + // "httpMethod": "GET", + // "id": "compute.regionZones.list", + // "parameterOrder": [ + // "project", + // "region" + // ], + // "parameters": { + // "filter": { + // "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.", + // "location": "query", + // "type": "string" + // }, + // "maxResults": { + // "default": "500", + // "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + // "format": "uint32", + // "location": "query", + // "minimum": "0", + // "type": "integer" + // }, + // "orderBy": { + // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + // "location": "query", + // "type": "string" + // }, + // "pageToken": { + // "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + // "location": "query", + // "type": "string" + // }, + // "project": { + // "description": "Project ID for this request.", + // "location": "path", + // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + // "required": true, + // "type": "string" + // }, + // "region": { + // "description": "Region for this request.", + // "location": "path", + // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + // "required": true, + // "type": "string" + // }, + // "returnPartialSuccess": { + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "location": "query", + // "type": "boolean" + // } + // }, + // "path": "projects/{project}/regions/{region}/zones", + // "response": { + // "$ref": "ZoneList" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform", + // "https://www.googleapis.com/auth/compute", + // "https://www.googleapis.com/auth/compute.readonly" + // ] + // } + +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *RegionZonesListCall) Pages(ctx context.Context, f func(*ZoneList) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + // method id "compute.regions.get": type RegionsGetCall struct { @@ -196655,7 +197193,7 @@ type SecurityPoliciesPatchCall struct { } // Patch: Patches the specified policy with the data included in the -// request. To clear fields in the rule, leave the fields empty and +// request. To clear fields in the policy, leave the fields empty and // specify them in the updateMask. This cannot be used to be update the // rules in the policy. Please use the per rule methods like addRule, // patchRule, and removeRule instead. @@ -196785,7 +197323,7 @@ func (c *SecurityPoliciesPatchCall) Do(opts ...googleapi.CallOption) (*Operation } return ret, nil // { - // "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + // "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", // "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}", // "httpMethod": "PATCH", // "id": "compute.securityPolicies.patch", @@ -196847,7 +197385,9 @@ type SecurityPoliciesPatchRuleCall struct { header_ http.Header } -// PatchRule: Patches a rule at the specified priority. +// PatchRule: Patches a rule at the specified priority. To clear fields +// in the rule, leave the fields empty and specify them in the +// updateMask. // // - project: Project ID for this request. // - securityPolicy: Name of the security policy to update. @@ -196972,7 +197512,7 @@ func (c *SecurityPoliciesPatchRuleCall) Do(opts ...googleapi.CallOption) (*Opera } return ret, nil // { - // "description": "Patches a rule at the specified priority.", + // "description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", // "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule", // "httpMethod": "POST", // "id": "compute.securityPolicies.patchRule", diff --git a/compute/v1/compute-api.json b/compute/v1/compute-api.json index 504c47fa972..8b77f64d425 100644 --- a/compute/v1/compute-api.json +++ b/compute/v1/compute-api.json @@ -23681,7 +23681,7 @@ ] }, "patch": { - "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "httpMethod": "PATCH", "id": "compute.regionSecurityPolicies.patch", @@ -26291,6 +26291,62 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "patch": { + "description": "Modify the specified resource policy.", + "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", + "httpMethod": "PATCH", + "id": "compute.resourcePolicies.patch", + "parameterOrder": [ + "project", + "region", + "resourcePolicy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "resourcePolicy": { + "description": "Id of the resource policy to patch.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "update_mask indicates fields to be updated as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", + "request": { + "$ref": "ResourcePolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy", @@ -27444,7 +27500,7 @@ ] }, "patch": { - "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}", "httpMethod": "PATCH", "id": "compute.securityPolicies.patch", @@ -27486,7 +27542,7 @@ ] }, "patchRule": { - "description": "Patches a rule at the specified priority.", + "description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule", "httpMethod": "POST", "id": "compute.securityPolicies.patchRule", @@ -33732,7 +33788,7 @@ } } }, - "revision": "20230701", + "revision": "20230711", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -36283,7 +36339,7 @@ "type": "string" }, "customResponseHeaders": { - "description": "Headers that the HTTP/S load balancer should add to proxied responses.", + "description": "Headers that the Application Load Balancer should add to proxied responses.", "items": { "type": "string" }, @@ -40368,11 +40424,13 @@ "description": "The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).", "enum": [ "ANY", + "ANY_SINGLE_ZONE", "BALANCED", "EVEN" ], "enumDescriptions": [ "The group picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.", + "The group creates all VM instances within a single zone. The zone is selected based on the present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads with heavy interprocess communication.", "The group prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across selected zones to minimize the impact of zonal failure. Recommended for highly available serving workloads.", "The group schedules VM instance creation and deletion to achieve and maintain an even number of managed instances across the selected zones. The distribution is even when the number of managed instances does not differ by more than 1 between any two zones. Recommended for highly available serving workloads." ], @@ -46538,14 +46596,14 @@ "type": "string" }, "type": { - "description": "The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).", + "description": "The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update.", "enum": [ "OPPORTUNISTIC", "PROACTIVE" ], "enumDescriptions": [ - "No action is being proactively performed in order to bring this IGM to its target version distribution (regardless of whether this distribution is expressed using instanceTemplate or versions field).", - "This IGM will actively converge to its target version distribution (regardless of whether this distribution is expressed using instanceTemplate or versions field)." + "MIG will apply new configurations to existing VMs only when you selectively target specific or all VMs to be updated.", + "MIG will automatically apply new configurations to all or a subset of existing VMs and also to new VMs that are added to the group." ], "type": "string" } @@ -60079,6 +60137,11 @@ "description": "The map holding related quota dimensions.", "type": "object" }, + "futureLimit": { + "description": "Future quota limit being rolled out. The limit's unit depends on the quota type or metric.", + "format": "double", + "type": "number" + }, "limit": { "description": "Current effective quota limit. The limit's unit depends on the quota type or metric.", "format": "double", @@ -60091,6 +60154,18 @@ "metricName": { "description": "The Compute Engine quota metric name.", "type": "string" + }, + "rolloutStatus": { + "description": "Rollout status of the future quota limit.", + "enum": [ + "IN_PROGRESS", + "ROLLOUT_STATUS_UNSPECIFIED" + ], + "enumDescriptions": [ + "IN_PROGRESS - A rollout is in process which will change the limit value to future limit.", + "ROLLOUT_STATUS_UNSPECIFIED - Rollout status is not specified. The default value." + ], + "type": "string" } }, "type": "object" @@ -65264,6 +65339,10 @@ ], "type": "string" }, + "localSsdRecoveryTimeout": { + "$ref": "Duration", + "description": "Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour." + }, "locationHint": { "description": "An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.", "type": "string" @@ -66728,6 +66807,10 @@ "description": "[Output Only] A connection connected to this service attachment.", "id": "ServiceAttachmentConnectedEndpoint", "properties": { + "consumerNetwork": { + "description": "The url of the consumer network.", + "type": "string" + }, "endpoint": { "description": "The url of a connected endpoint.", "type": "string" diff --git a/compute/v1/compute-gen.go b/compute/v1/compute-gen.go index f7315454ff5..811675da12d 100644 --- a/compute/v1/compute-gen.go +++ b/compute/v1/compute-gen.go @@ -4922,8 +4922,8 @@ type BackendBucket struct { // format. CreationTimestamp string `json:"creationTimestamp,omitempty"` - // CustomResponseHeaders: Headers that the HTTP/S load balancer should - // add to proxied responses. + // CustomResponseHeaders: Headers that the Application Load Balancer + // should add to proxied responses. CustomResponseHeaders []string `json:"customResponseHeaders,omitempty"` // Description: An optional textual description of the resource; @@ -10928,6 +10928,11 @@ type DistributionPolicy struct { // the requested number of VMs within present resource constraints and // to maximize utilization of unused zonal reservations. Recommended for // batch workloads that do not require high availability. + // "ANY_SINGLE_ZONE" - The group creates all VM instances within a + // single zone. The zone is selected based on the present resource + // constraints and to maximize utilization of unused zonal reservations. + // Recommended for batch workloads with heavy interprocess + // communication. // "BALANCED" - The group prioritizes acquisition of resources, // scheduling VMs in zones where resources are available while // distributing VMs as evenly as possible across selected zones to @@ -19865,20 +19870,16 @@ type InstanceGroupManagerUpdatePolicy struct { ReplacementMethod string `json:"replacementMethod,omitempty"` // Type: The type of update process. You can specify either PROACTIVE so - // that the instance group manager proactively executes actions in order - // to bring instances to their target versions or OPPORTUNISTIC so that - // no action is proactively executed but the update will be performed as - // part of other actions (for example, resizes or recreateInstances - // calls). + // that the MIG automatically updates VMs to the latest configurations + // or OPPORTUNISTIC so that you can select the VMs that you want to + // update. // // Possible values: - // "OPPORTUNISTIC" - No action is being proactively performed in order - // to bring this IGM to its target version distribution (regardless of - // whether this distribution is expressed using instanceTemplate or - // versions field). - // "PROACTIVE" - This IGM will actively converge to its target version - // distribution (regardless of whether this distribution is expressed - // using instanceTemplate or versions field). + // "OPPORTUNISTIC" - MIG will apply new configurations to existing VMs + // only when you selectively target specific or all VMs to be updated. + // "PROACTIVE" - MIG will automatically apply new configurations to + // all or a subset of existing VMs and also to new VMs that are added to + // the group. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -38418,6 +38419,10 @@ type QuotaExceededInfo struct { // Dimensions: The map holding related quota dimensions. Dimensions map[string]string `json:"dimensions,omitempty"` + // FutureLimit: Future quota limit being rolled out. The limit's unit + // depends on the quota type or metric. + FutureLimit float64 `json:"futureLimit,omitempty"` + // Limit: Current effective quota limit. The limit's unit depends on the // quota type or metric. Limit float64 `json:"limit,omitempty"` @@ -38428,6 +38433,15 @@ type QuotaExceededInfo struct { // MetricName: The Compute Engine quota metric name. MetricName string `json:"metricName,omitempty"` + // RolloutStatus: Rollout status of the future quota limit. + // + // Possible values: + // "IN_PROGRESS" - IN_PROGRESS - A rollout is in process which will + // change the limit value to future limit. + // "ROLLOUT_STATUS_UNSPECIFIED" - ROLLOUT_STATUS_UNSPECIFIED - Rollout + // status is not specified. The default value. + RolloutStatus string `json:"rolloutStatus,omitempty"` + // ForceSendFields is a list of field names (e.g. "Dimensions") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -38454,13 +38468,15 @@ func (s *QuotaExceededInfo) MarshalJSON() ([]byte, error) { func (s *QuotaExceededInfo) UnmarshalJSON(data []byte) error { type NoMethod QuotaExceededInfo var s1 struct { - Limit gensupport.JSONFloat64 `json:"limit"` + FutureLimit gensupport.JSONFloat64 `json:"futureLimit"` + Limit gensupport.JSONFloat64 `json:"limit"` *NoMethod } s1.NoMethod = (*NoMethod)(s) if err := json.Unmarshal(data, &s1); err != nil { return err } + s.FutureLimit = float64(s1.FutureLimit) s.Limit = float64(s1.Limit) return nil } @@ -45495,6 +45511,12 @@ type Scheduling struct { // action. InstanceTerminationAction string `json:"instanceTerminationAction,omitempty"` + // LocalSsdRecoveryTimeout: Specifies the maximum amount of time a Local + // Ssd Vm should wait while recovery of the Local Ssd state is + // attempted. Its value should be in between 0 and 168 hours with hour + // granularity and the default value being 1 hour. + LocalSsdRecoveryTimeout *Duration `json:"localSsdRecoveryTimeout,omitempty"` + // LocationHint: An opaque location hint used to place the instance // close to other resources. This field is for use by internal tools // that use the public API. @@ -47719,6 +47741,9 @@ func (s *ServiceAttachmentAggregatedListWarningData) MarshalJSON() ([]byte, erro // ServiceAttachmentConnectedEndpoint: [Output Only] A connection // connected to this service attachment. type ServiceAttachmentConnectedEndpoint struct { + // ConsumerNetwork: The url of the consumer network. + ConsumerNetwork string `json:"consumerNetwork,omitempty"` + // Endpoint: The url of a connected endpoint. Endpoint string `json:"endpoint,omitempty"` @@ -47740,7 +47765,7 @@ type ServiceAttachmentConnectedEndpoint struct { // "STATUS_UNSPECIFIED" Status string `json:"status,omitempty"` - // ForceSendFields is a list of field names (e.g. "Endpoint") to + // ForceSendFields is a list of field names (e.g. "ConsumerNetwork") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -47748,12 +47773,13 @@ type ServiceAttachmentConnectedEndpoint struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Endpoint") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "ConsumerNetwork") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. NullFields []string `json:"-"` } @@ -160131,7 +160157,7 @@ type RegionSecurityPoliciesPatchCall struct { } // Patch: Patches the specified policy with the data included in the -// request. To clear fields in the rule, leave the fields empty and +// request. To clear fields in the policy, leave the fields empty and // specify them in the updateMask. This cannot be used to be update the // rules in the policy. Please use the per rule methods like addRule, // patchRule, and removeRule instead. @@ -160257,7 +160283,7 @@ func (c *RegionSecurityPoliciesPatchCall) Do(opts ...googleapi.CallOption) (*Ope } return ret, nil // { - // "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + // "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", // "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", // "httpMethod": "PATCH", // "id": "compute.regionSecurityPolicies.patch", @@ -170756,6 +170782,207 @@ func (c *ResourcePoliciesListCall) Pages(ctx context.Context, f func(*ResourcePo } } +// method id "compute.resourcePolicies.patch": + +type ResourcePoliciesPatchCall struct { + s *Service + project string + region string + resourcePolicy string + resourcepolicy *ResourcePolicy + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Patch: Modify the specified resource policy. +// +// - project: Project ID for this request. +// - region: Name of the region for this request. +// - resourcePolicy: Id of the resource policy to patch. +func (r *ResourcePoliciesService) Patch(project string, region string, resourcePolicy string, resourcepolicy *ResourcePolicy) *ResourcePoliciesPatchCall { + c := &ResourcePoliciesPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.project = project + c.region = region + c.resourcePolicy = resourcePolicy + c.resourcepolicy = resourcepolicy + return c +} + +// RequestId sets the optional parameter "requestId": An optional +// request ID to identify requests. Specify a unique request ID so that +// if you must retry your request, the server will know to ignore the +// request if it has already been completed. For example, consider a +// situation where you make an initial request and the request times +// out. If you make the request again with the same request ID, the +// server can check if original operation with the same request ID was +// received, and if so, will ignore the second request. This prevents +// clients from accidentally creating duplicate commitments. The request +// ID must be a valid UUID with the exception that zero UUID is not +// supported ( 00000000-0000-0000-0000-000000000000). +func (c *ResourcePoliciesPatchCall) RequestId(requestId string) *ResourcePoliciesPatchCall { + c.urlParams_.Set("requestId", requestId) + return c +} + +// UpdateMask sets the optional parameter "updateMask": update_mask +// indicates fields to be updated as part of this request. +func (c *ResourcePoliciesPatchCall) UpdateMask(updateMask string) *ResourcePoliciesPatchCall { + c.urlParams_.Set("updateMask", updateMask) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ResourcePoliciesPatchCall) Fields(s ...googleapi.Field) *ResourcePoliciesPatchCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ResourcePoliciesPatchCall) Context(ctx context.Context) *ResourcePoliciesPatchCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ResourcePoliciesPatchCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ResourcePoliciesPatchCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.resourcepolicy) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("PATCH", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "project": c.project, + "region": c.region, + "resourcePolicy": c.resourcePolicy, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "compute.resourcePolicies.patch" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ResourcePoliciesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Modify the specified resource policy.", + // "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", + // "httpMethod": "PATCH", + // "id": "compute.resourcePolicies.patch", + // "parameterOrder": [ + // "project", + // "region", + // "resourcePolicy" + // ], + // "parameters": { + // "project": { + // "description": "Project ID for this request.", + // "location": "path", + // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + // "required": true, + // "type": "string" + // }, + // "region": { + // "description": "Name of the region for this request.", + // "location": "path", + // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + // "required": true, + // "type": "string" + // }, + // "requestId": { + // "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + // "location": "query", + // "type": "string" + // }, + // "resourcePolicy": { + // "description": "Id of the resource policy to patch.", + // "location": "path", + // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + // "required": true, + // "type": "string" + // }, + // "updateMask": { + // "description": "update_mask indicates fields to be updated as part of this request.", + // "format": "google-fieldmask", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", + // "request": { + // "$ref": "ResourcePolicy" + // }, + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform", + // "https://www.googleapis.com/auth/compute" + // ] + // } + +} + // method id "compute.resourcePolicies.setIamPolicy": type ResourcePoliciesSetIamPolicyCall struct { @@ -175722,7 +175949,7 @@ type SecurityPoliciesPatchCall struct { } // Patch: Patches the specified policy with the data included in the -// request. To clear fields in the rule, leave the fields empty and +// request. To clear fields in the policy, leave the fields empty and // specify them in the updateMask. This cannot be used to be update the // rules in the policy. Please use the per rule methods like addRule, // patchRule, and removeRule instead. @@ -175845,7 +176072,7 @@ func (c *SecurityPoliciesPatchCall) Do(opts ...googleapi.CallOption) (*Operation } return ret, nil // { - // "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + // "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", // "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}", // "httpMethod": "PATCH", // "id": "compute.securityPolicies.patch", @@ -175901,7 +176128,9 @@ type SecurityPoliciesPatchRuleCall struct { header_ http.Header } -// PatchRule: Patches a rule at the specified priority. +// PatchRule: Patches a rule at the specified priority. To clear fields +// in the rule, leave the fields empty and specify them in the +// updateMask. // // - project: Project ID for this request. // - securityPolicy: Name of the security policy to update. @@ -176019,7 +176248,7 @@ func (c *SecurityPoliciesPatchRuleCall) Do(opts ...googleapi.CallOption) (*Opera } return ret, nil // { - // "description": "Patches a rule at the specified priority.", + // "description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", // "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule", // "httpMethod": "POST", // "id": "compute.securityPolicies.patchRule", diff --git a/dialogflow/v2/dialogflow-api.json b/dialogflow/v2/dialogflow-api.json index a47414ff8f6..61715e77fed 100644 --- a/dialogflow/v2/dialogflow-api.json +++ b/dialogflow/v2/dialogflow-api.json @@ -1230,7 +1230,7 @@ ], "parameters": { "name": { - "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "location": "path", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", "required": true, @@ -2256,7 +2256,7 @@ ], "parameters": { "name": { - "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "location": "path", "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", "required": true, @@ -3284,7 +3284,7 @@ ], "parameters": { "conversationId": { - "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula \"a-zA-Z*\" with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", + "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" }, @@ -5320,7 +5320,7 @@ ], "parameters": { "name": { - "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", "required": true, @@ -5986,7 +5986,7 @@ ], "parameters": { "name": { - "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", "required": true, @@ -7098,7 +7098,7 @@ ], "parameters": { "conversationId": { - "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula \"a-zA-Z*\" with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", + "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" }, @@ -8211,7 +8211,7 @@ } } }, - "revision": "20230705", + "revision": "20230711", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -8615,7 +8615,7 @@ "type": "string" }, "commitSha": { - "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "description": "Commit SHA of the git push. This field is populated if `git_destination` is specified in ExportAgentRequest.", "type": "string" } }, @@ -9308,6 +9308,22 @@ "$ref": "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio", "description": "Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way." }, + "responseType": { + "description": "Response type.", + "enum": [ + "RESPONSE_TYPE_UNSPECIFIED", + "ENTRY_PROMPT", + "PARAMETER_PROMPT", + "HANDLER_PROMPT" + ], + "enumDescriptions": [ + "Not specified.", + "The response is from an entry prompt in the page.", + "The response is from form-filling prompt in the page.", + "The response is from a transition route or an event handler in the page or flow or transition route group." + ], + "type": "string" + }, "telephonyTransferCall": { "$ref": "GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall", "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." @@ -10547,7 +10563,7 @@ "type": "string" }, "commitSha": { - "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "description": "Commit SHA of the git push. This field is populated if `git_destination` is specified in ExportAgentRequest.", "type": "string" } }, @@ -12832,7 +12848,7 @@ "type": "integer" }, "name": { - "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "type": "string" }, "parameters": { @@ -12840,7 +12856,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" } }, @@ -13752,7 +13768,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" } }, @@ -13935,7 +13951,7 @@ "id": "GoogleCloudDialogflowV2GcsDestination", "properties": { "uri": { - "description": "The Google Cloud Storage URIs for the output. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", + "description": "The Google Cloud Storage URIs for the output. A URI is of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", "type": "string" } }, @@ -13946,7 +13962,7 @@ "id": "GoogleCloudDialogflowV2GcsSources", "properties": { "uris": { - "description": "Required. Google Cloud Storage URIs for the inputs. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case.", + "description": "Required. Google Cloud Storage URIs for the inputs. A URI is of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is used depends on the use case.", "items": { "type": "string" }, @@ -14526,7 +14542,7 @@ }, "phraseHints": { "deprecated": true, - "description": "A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [speech_contexts]() instead. If you specify both [phrase_hints]() and [speech_contexts](), Dialogflow will treat the [phrase_hints]() as a single additional [SpeechContext]().", + "description": "A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`]().", "items": { "type": "string" }, @@ -16205,7 +16221,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" }, "queryText": { @@ -16835,7 +16851,7 @@ "type": "object" }, "GoogleCloudDialogflowV2TextInput": { - "description": "============================================================================ Auxiliary proto messages. Represents the natural language text to be processed.", + "description": "Auxiliary proto messages. Represents the natural language text to be processed.", "id": "GoogleCloudDialogflowV2TextInput", "properties": { "languageCode": { @@ -16925,7 +16941,7 @@ "id": "GoogleCloudDialogflowV2ValidationError", "properties": { "entries": { - "description": "The names of the entries that the error is associated with. Format: - \"projects//agent\", if the error is associated with the entire agent. - \"projects//agent/intents/\", if the error is associated with certain intents. - \"projects//agent/intents//trainingPhrases/\", if the error is associated with certain intent training phrases. - \"projects//agent/intents//parameters/\", if the error is associated with certain intent parameters. - \"projects//agent/entities/\", if the error is associated with certain entities.", + "description": "The names of the entries that the error is associated with. Format: - `projects//agent`, if the error is associated with the entire agent. - `projects//agent/intents/`, if the error is associated with certain intents. - `projects//agent/intents//trainingPhrases/`, if the error is associated with certain intent training phrases. - `projects//agent/intents//parameters/`, if the error is associated with certain intent parameters. - `projects//agent/entities/`, if the error is associated with certain entities.", "items": { "type": "string" }, @@ -17255,7 +17271,7 @@ "type": "integer" }, "name": { - "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "type": "string" }, "parameters": { @@ -17263,7 +17279,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" } }, @@ -17416,7 +17432,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" } }, @@ -17489,7 +17505,7 @@ "id": "GoogleCloudDialogflowV2beta1GcsDestination", "properties": { "uri": { - "description": "Required. The Google Cloud Storage URIs for the output. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", + "description": "Required. The Google Cloud Storage URIs for the output. A URI is of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", "type": "string" } }, @@ -19015,7 +19031,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" }, "queryText": { diff --git a/dialogflow/v2/dialogflow-gen.go b/dialogflow/v2/dialogflow-gen.go index 4c250582310..7f8bbce7cd6 100644 --- a/dialogflow/v2/dialogflow-gen.go +++ b/dialogflow/v2/dialogflow-gen.go @@ -1613,7 +1613,7 @@ type GoogleCloudDialogflowCxV3ExportAgentResponse struct { AgentUri string `json:"agentUri,omitempty"` // CommitSha: Commit SHA of the git push. This field is populated if - // `git_destination` are specified in ExportAgentRequest. + // `git_destination` is specified in ExportAgentRequest. CommitSha string `json:"commitSha,omitempty"` // ForceSendFields is a list of field names (e.g. "AgentContent") to @@ -2968,6 +2968,17 @@ type GoogleCloudDialogflowCxV3ResponseMessage struct { // any way. PlayAudio *GoogleCloudDialogflowCxV3ResponseMessagePlayAudio `json:"playAudio,omitempty"` + // ResponseType: Response type. + // + // Possible values: + // "RESPONSE_TYPE_UNSPECIFIED" - Not specified. + // "ENTRY_PROMPT" - The response is from an entry prompt in the page. + // "PARAMETER_PROMPT" - The response is from form-filling prompt in + // the page. + // "HANDLER_PROMPT" - The response is from a transition route or an + // event handler in the page or flow or transition route group. + ResponseType string `json:"responseType,omitempty"` + // TelephonyTransferCall: A signal that the client should transfer the // phone call connected to this agent to a third-party endpoint. TelephonyTransferCall *GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall `json:"telephonyTransferCall,omitempty"` @@ -5190,7 +5201,7 @@ type GoogleCloudDialogflowCxV3beta1ExportAgentResponse struct { AgentUri string `json:"agentUri,omitempty"` // CommitSha: Commit SHA of the git push. This field is populated if - // `git_destination` are specified in ExportAgentRequest. + // `git_destination` is specified in ExportAgentRequest. CommitSha string `json:"commitSha,omitempty"` // ForceSendFields is a list of field names (e.g. "AgentContent") to @@ -9293,7 +9304,7 @@ type GoogleCloudDialogflowV2Context struct { // `projects//agent/sessions//contexts/`, or // `projects//agent/environments//users//sessions//contexts/`. The // `Context ID` is always converted to lowercase, may only contain - // characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If + // characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If // `Environment ID` is not specified, we assume default 'draft' // environment. If `User ID` is not specified, we assume default '-' // user. The following context names are reserved for internal use by @@ -9305,13 +9316,14 @@ type GoogleCloudDialogflowV2Context struct { // Parameters: Optional. The collection of parameters associated with // this context. Depending on your protocol or client library language, // this is a map, associative array, symbol table, dictionary, or JSON - // object composed of a collection of (MapKey, MapValue) pairs: - MapKey - // type: string - MapKey value: parameter name - MapValue type: - If - // parameter's entity type is a composite entity: map - Else: depending - // on parameter value type, could be one of string, number, boolean, - // null, list or map - MapValue value: - If parameter's entity type is a - // composite entity: map from composite entity property names to - // property values - Else: parameter value + // object composed of a collection of (MapKey, MapValue) pairs: * MapKey + // type: string * MapKey value: parameter name * MapValue type: If + // parameter's entity type is a composite entity then use map, + // otherwise, depending on the parameter value type, it could be one of + // string, number, boolean, null, list or map. * MapValue value: If + // parameter's entity type is a composite entity then use map from + // composite entity property names to property values, otherwise, use + // parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -10818,13 +10830,13 @@ type GoogleCloudDialogflowV2EventInput struct { // Parameters: The collection of parameters associated with the event. // Depending on your protocol or client library language, this is a map, // associative array, symbol table, dictionary, or JSON object composed - // of a collection of (MapKey, MapValue) pairs: - MapKey type: string - - // MapKey value: parameter name - MapValue type: - If parameter's entity - // type is a composite entity: map - Else: depending on parameter value - // type, could be one of string, number, boolean, null, list or map - - // MapValue value: - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - Else: - // parameter value + // of a collection of (MapKey, MapValue) pairs: * MapKey type: string * + // MapKey value: parameter name * MapValue type: If parameter's entity + // type is a composite entity then use map, otherwise, depending on the + // parameter value type, it could be one of string, number, boolean, + // null, list or map. * MapValue value: If parameter's entity type is a + // composite entity then use map from composite entity property names to + // property values, otherwise, use parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "LanguageCode") to @@ -11199,7 +11211,7 @@ func (s *GoogleCloudDialogflowV2FulfillmentGenericWebService) MarshalJSON() ([]b // for the output. type GoogleCloudDialogflowV2GcsDestination struct { // Uri: The Google Cloud Storage URIs for the output. A URI is of the - // form: gs://bucket/object-prefix-or-name Whether a prefix or name is + // form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is // used depends on the use case. The requesting user must have // "write-permission" to the bucket. Uri string `json:"uri,omitempty"` @@ -11231,8 +11243,8 @@ func (s *GoogleCloudDialogflowV2GcsDestination) MarshalJSON() ([]byte, error) { // the inputs. type GoogleCloudDialogflowV2GcsSources struct { // Uris: Required. Google Cloud Storage URIs for the inputs. A URI is of - // the form: gs://bucket/object-prefix-or-name Whether a prefix or name - // is used depends on the use case. + // the form: `gs://bucket/object-prefix-or-name` Whether a prefix or + // name is used depends on the use case. Uris []string `json:"uris,omitempty"` // ForceSendFields is a list of field names (e.g. "Uris") to @@ -12457,9 +12469,9 @@ type GoogleCloudDialogflowV2InputAudioConfig struct { // Cloud Speech documentation // (https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) // for more details. This field is deprecated. Please use - // speech_contexts () instead. If you specify both phrase_hints () and - // speech_contexts (), Dialogflow will treat the phrase_hints () as a - // single additional SpeechContext (). + // `speech_contexts` () instead. If you specify both `phrase_hints` () + // and `speech_contexts` (), Dialogflow will treat the `phrase_hints` () + // as a single additional `SpeechContext` (). PhraseHints []string `json:"phraseHints,omitempty"` // SampleRateHertz: Required. Sample rate (in Hertz) of the audio @@ -15308,13 +15320,13 @@ type GoogleCloudDialogflowV2QueryResult struct { // Parameters: The collection of extracted parameters. Depending on your // protocol or client library language, this is a map, associative // array, symbol table, dictionary, or JSON object composed of a - // collection of (MapKey, MapValue) pairs: - MapKey type: string - - // MapKey value: parameter name - MapValue type: - If parameter's entity - // type is a composite entity: map - Else: depending on parameter value - // type, could be one of string, number, boolean, null, list or map - - // MapValue value: - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - Else: - // parameter value + // collection of (MapKey, MapValue) pairs: * MapKey type: string * + // MapKey value: parameter name * MapValue type: If parameter's entity + // type is a composite entity then use map, otherwise, depending on the + // parameter value type, it could be one of string, number, boolean, + // null, list or map. * MapValue value: If parameter's entity type is a + // composite entity then use map from composite entity property names to + // property values, otherwise, use parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // QueryText: The original conversational query text: - If natural @@ -16659,10 +16671,8 @@ func (s *GoogleCloudDialogflowV2SynthesizeSpeechConfig) UnmarshalJSON(data []byt return nil } -// GoogleCloudDialogflowV2TextInput: -// ====================================================================== -// ====== Auxiliary proto messages. Represents the natural language text -// to be processed. +// GoogleCloudDialogflowV2TextInput: Auxiliary proto messages. +// Represents the natural language text to be processed. type GoogleCloudDialogflowV2TextInput struct { // LanguageCode: Required. The language of this conversational query. // See Language Support @@ -16815,13 +16825,13 @@ type GoogleCloudDialogflowV2UndeployConversationModelRequest struct { // validation error. type GoogleCloudDialogflowV2ValidationError struct { // Entries: The names of the entries that the error is associated with. - // Format: - "projects//agent", if the error is associated with the - // entire agent. - "projects//agent/intents/", if the error is + // Format: - `projects//agent`, if the error is associated with the + // entire agent. - `projects//agent/intents/`, if the error is // associated with certain intents. - - // "projects//agent/intents//trainingPhrases/", if the error is + // `projects//agent/intents//trainingPhrases/`, if the error is // associated with certain intent training phrases. - - // "projects//agent/intents//parameters/", if the error is associated - // with certain intent parameters. - "projects//agent/entities/", if the + // `projects//agent/intents//parameters/`, if the error is associated + // with certain intent parameters. - `projects//agent/entities/`, if the // error is associated with certain entities. Entries []string `json:"entries,omitempty"` @@ -17377,7 +17387,7 @@ type GoogleCloudDialogflowV2beta1Context struct { // `projects//agent/environments//users//sessions//contexts/`, - // `projects//locations//agent/environments//users//sessions//contexts/`, // The `Context ID` is always converted to lowercase, may only contain - // characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If + // characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If // `Environment ID` is not specified, we assume default 'draft' // environment. If `User ID` is not specified, we assume default '-' // user. The following context names are reserved for internal use by @@ -17389,13 +17399,14 @@ type GoogleCloudDialogflowV2beta1Context struct { // Parameters: Optional. The collection of parameters associated with // this context. Depending on your protocol or client library language, // this is a map, associative array, symbol table, dictionary, or JSON - // object composed of a collection of (MapKey, MapValue) pairs: - MapKey - // type: string - MapKey value: parameter name - MapValue type: - If - // parameter's entity type is a composite entity: map - Else: depending - // on parameter value type, could be one of string, number, boolean, - // null, list or map - MapValue value: - If parameter's entity type is a - // composite entity: map from composite entity property names to - // property values - Else: parameter value + // object composed of a collection of (MapKey, MapValue) pairs: * MapKey + // type: string * MapKey value: parameter name * MapValue type: If + // parameter's entity type is a composite entity then use map, + // otherwise, depending on the parameter value type, it could be one of + // string, number, boolean, null, list or map. * MapValue value: If + // parameter's entity type is a composite entity then use map from + // composite entity property names to property values, otherwise, use + // parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "LifespanCount") to @@ -17657,13 +17668,13 @@ type GoogleCloudDialogflowV2beta1EventInput struct { // Parameters: The collection of parameters associated with the event. // Depending on your protocol or client library language, this is a map, // associative array, symbol table, dictionary, or JSON object composed - // of a collection of (MapKey, MapValue) pairs: - MapKey type: string - - // MapKey value: parameter name - MapValue type: - If parameter's entity - // type is a composite entity: map - Else: depending on parameter value - // type, could be one of string, number, boolean, null, list or map - - // MapValue value: - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - Else: - // parameter value + // of a collection of (MapKey, MapValue) pairs: * MapKey type: string * + // MapKey value: parameter name * MapValue type: If parameter's entity + // type is a composite entity then use map, otherwise, depending on the + // parameter value type, it could be one of string, number, boolean, + // null, list or map. * MapValue value: If parameter's entity type is a + // composite entity then use map from composite entity property names to + // property values, otherwise, use parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "LanguageCode") to @@ -17822,7 +17833,7 @@ func (s *GoogleCloudDialogflowV2beta1FaqAnswer) UnmarshalJSON(data []byte) error // location for the output. type GoogleCloudDialogflowV2beta1GcsDestination struct { // Uri: Required. The Google Cloud Storage URIs for the output. A URI is - // of the form: gs://bucket/object-prefix-or-name Whether a prefix or + // of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or // name is used depends on the use case. The requesting user must have // "write-permission" to the bucket. Uri string `json:"uri,omitempty"` @@ -20296,13 +20307,13 @@ type GoogleCloudDialogflowV2beta1QueryResult struct { // Parameters: The collection of extracted parameters. Depending on your // protocol or client library language, this is a map, associative // array, symbol table, dictionary, or JSON object composed of a - // collection of (MapKey, MapValue) pairs: - MapKey type: string - - // MapKey value: parameter name - MapValue type: - If parameter's entity - // type is a composite entity: map - Else: depending on parameter value - // type, could be one of string, number, boolean, null, list or map - - // MapValue value: - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - Else: - // parameter value + // collection of (MapKey, MapValue) pairs: * MapKey type: string * + // MapKey value: parameter name * MapValue type: If parameter's entity + // type is a composite entity then use map, otherwise, depending on the + // parameter value type, it could be one of string, number, boolean, + // null, list or map. * MapValue value: If parameter's entity type is a + // composite entity then use map from composite entity property names to + // property values, otherwise, use parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // QueryText: The original conversational query text: - If natural @@ -27242,7 +27253,7 @@ type ProjectsAgentEnvironmentsUsersSessionsContextsPatchCall struct { // `projects//agent/sessions//contexts/`, or // `projects//agent/environments//users//sessions//contexts/`. The // `Context ID` is always converted to lowercase, may only contain -// characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If +// characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If // `Environment ID` is not specified, we assume default 'draft' // environment. If `User ID` is not specified, we assume default '-' // user. The following context names are reserved for internal use by @@ -27363,7 +27374,7 @@ func (c *ProjectsAgentEnvironmentsUsersSessionsContextsPatchCall) Do(opts ...goo // ], // "parameters": { // "name": { - // "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + // "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", // "location": "path", // "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", // "required": true, @@ -32232,7 +32243,7 @@ type ProjectsAgentSessionsContextsPatchCall struct { // `projects//agent/sessions//contexts/`, or // `projects//agent/environments//users//sessions//contexts/`. The // `Context ID` is always converted to lowercase, may only contain -// characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If +// characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If // `Environment ID` is not specified, we assume default 'draft' // environment. If `User ID` is not specified, we assume default '-' // user. The following context names are reserved for internal use by @@ -32353,7 +32364,7 @@ func (c *ProjectsAgentSessionsContextsPatchCall) Do(opts ...googleapi.CallOption // ], // "parameters": { // "name": { - // "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + // "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", // "location": "path", // "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", // "required": true, @@ -37427,7 +37438,7 @@ func (r *ProjectsConversationsService) Create(parentid string, googleclouddialog // Identifier of the conversation. Generally it's auto generated by // Google. Only set it if you cannot wait for the response to return a // auto-generated one to you. The conversation ID must be compliant with -// the regression fomula "a-zA-Z*" with the characters length in range +// the regression fomula `a-zA-Z*` with the characters length in range // of [3,64]. If the field is provided, the caller is resposible for 1. // the uniqueness of the ID, otherwise the request will be rejected. 2. // the consistency for whether to use custom ID or not under a project @@ -37538,7 +37549,7 @@ func (c *ProjectsConversationsCreateCall) Do(opts ...googleapi.CallOption) (*Goo // ], // "parameters": { // "conversationId": { - // "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula \"a-zA-Z*\" with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", + // "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", // "location": "query", // "type": "string" // }, @@ -47588,7 +47599,7 @@ type ProjectsLocationsAgentEnvironmentsUsersSessionsContextsPatchCall struct { // `projects//agent/sessions//contexts/`, or // `projects//agent/environments//users//sessions//contexts/`. The // `Context ID` is always converted to lowercase, may only contain -// characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If +// characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If // `Environment ID` is not specified, we assume default 'draft' // environment. If `User ID` is not specified, we assume default '-' // user. The following context names are reserved for internal use by @@ -47709,7 +47720,7 @@ func (c *ProjectsLocationsAgentEnvironmentsUsersSessionsContextsPatchCall) Do(op // ], // "parameters": { // "name": { - // "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + // "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", // "required": true, @@ -50784,7 +50795,7 @@ type ProjectsLocationsAgentSessionsContextsPatchCall struct { // `projects//agent/sessions//contexts/`, or // `projects//agent/environments//users//sessions//contexts/`. The // `Context ID` is always converted to lowercase, may only contain -// characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If +// characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If // `Environment ID` is not specified, we assume default 'draft' // environment. If `User ID` is not specified, we assume default '-' // user. The following context names are reserved for internal use by @@ -50905,7 +50916,7 @@ func (c *ProjectsLocationsAgentSessionsContextsPatchCall) Do(opts ...googleapi.C // ], // "parameters": { // "name": { - // "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + // "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", // "required": true, @@ -56412,7 +56423,7 @@ func (r *ProjectsLocationsConversationsService) Create(parentid string, googlecl // Identifier of the conversation. Generally it's auto generated by // Google. Only set it if you cannot wait for the response to return a // auto-generated one to you. The conversation ID must be compliant with -// the regression fomula "a-zA-Z*" with the characters length in range +// the regression fomula `a-zA-Z*` with the characters length in range // of [3,64]. If the field is provided, the caller is resposible for 1. // the uniqueness of the ID, otherwise the request will be rejected. 2. // the consistency for whether to use custom ID or not under a project @@ -56523,7 +56534,7 @@ func (c *ProjectsLocationsConversationsCreateCall) Do(opts ...googleapi.CallOpti // ], // "parameters": { // "conversationId": { - // "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula \"a-zA-Z*\" with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", + // "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", // "location": "query", // "type": "string" // }, diff --git a/dialogflow/v2beta1/dialogflow-api.json b/dialogflow/v2beta1/dialogflow-api.json index e7e1bbe3d0a..cc0036c29ba 100644 --- a/dialogflow/v2beta1/dialogflow-api.json +++ b/dialogflow/v2beta1/dialogflow-api.json @@ -1230,7 +1230,7 @@ ], "parameters": { "name": { - "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "location": "path", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", "required": true, @@ -2261,7 +2261,7 @@ ], "parameters": { "name": { - "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "location": "path", "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", "required": true, @@ -2971,7 +2971,7 @@ ], "parameters": { "conversationId": { - "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula \"a-zA-Z*\" with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", + "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" }, @@ -5085,7 +5085,7 @@ ], "parameters": { "name": { - "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", "required": true, @@ -5751,7 +5751,7 @@ ], "parameters": { "name": { - "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", "required": true, @@ -6461,7 +6461,7 @@ ], "parameters": { "conversationId": { - "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula \"a-zA-Z*\" with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", + "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" }, @@ -7579,7 +7579,7 @@ } } }, - "revision": "20230705", + "revision": "20230711", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -7983,7 +7983,7 @@ "type": "string" }, "commitSha": { - "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "description": "Commit SHA of the git push. This field is populated if `git_destination` is specified in ExportAgentRequest.", "type": "string" } }, @@ -8676,6 +8676,22 @@ "$ref": "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio", "description": "Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way." }, + "responseType": { + "description": "Response type.", + "enum": [ + "RESPONSE_TYPE_UNSPECIFIED", + "ENTRY_PROMPT", + "PARAMETER_PROMPT", + "HANDLER_PROMPT" + ], + "enumDescriptions": [ + "Not specified.", + "The response is from an entry prompt in the page.", + "The response is from form-filling prompt in the page.", + "The response is from a transition route or an event handler in the page or flow or transition route group." + ], + "type": "string" + }, "telephonyTransferCall": { "$ref": "GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall", "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." @@ -9915,7 +9931,7 @@ "type": "string" }, "commitSha": { - "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "description": "Commit SHA of the git push. This field is populated if `git_destination` is specified in ExportAgentRequest.", "type": "string" } }, @@ -11610,7 +11626,7 @@ "type": "integer" }, "name": { - "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "type": "string" }, "parameters": { @@ -11618,7 +11634,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" } }, @@ -11946,7 +11962,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" } }, @@ -12019,7 +12035,7 @@ "id": "GoogleCloudDialogflowV2GcsDestination", "properties": { "uri": { - "description": "The Google Cloud Storage URIs for the output. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", + "description": "The Google Cloud Storage URIs for the output. A URI is of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", "type": "string" } }, @@ -13221,7 +13237,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" }, "queryText": { @@ -13806,7 +13822,7 @@ "description": "An input event to send to Dialogflow." }, "messageSendTime": { - "description": "Optional. The send time of the message from end user or human agent's perspective. It is used for identifying the same message under one participant. Given two messages under the same participant: - If send time are different regardless of whether the content of the messages are exactly the same, the conversation will regard them as two distinct messages sent by the participant. - If send time is the same regardless of whether the content of the messages are exactly the same, the conversation will regard them as same message, and ignore the message received later. If the value is not provided, a new request will always be regarded as a new message without any de-duplication.", + "description": "Optional. The send time of the message from end user or human agent's perspective. It is used for identifying the same message under one participant. Given two messages under the same participant: * If send time are different regardless of whether the content of the messages are exactly the same, the conversation will regard them as two distinct messages sent by the participant. * If send time is the same regardless of whether the content of the messages are exactly the same, the conversation will regard them as same message, and ignore the message received later. If the value is not provided, a new request will always be regarded as a new message without any de-duplication.", "format": "google-datetime", "type": "string" }, @@ -14107,7 +14123,7 @@ "type": "object" }, "GoogleCloudDialogflowV2beta1BargeInConfig": { - "description": "Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length fromt the the start of the input audio. The flow goes like below: --\u003e Time without speech detection | utterance only | utterance or no-speech event | | +-------------+ | +------------+ | +---------------+ ----------+ no barge-in +-|-+ barge-in +-|-+ normal period +----------- +-------------+ | +------------+ | +---------------+ No-speech event is a response with END_OF_UTTERANCE without any transcript following up.", + "description": "Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length fromt the the start of the input audio. The flow goes like below: ``` --\u003e Time without speech detection | utterance only | utterance or no-speech event | | +-------------+ | +------------+ | +---------------+ ----------+ no barge-in +-|-+ barge-in +-|-+ normal period +----------- +-------------+ | +------------+ | +---------------+ ``` No-speech event is a response with END_OF_UTTERANCE without any transcript following up.", "id": "GoogleCloudDialogflowV2beta1BargeInConfig", "properties": { "noBargeInDuration": { @@ -14475,7 +14491,7 @@ "type": "integer" }, "name": { - "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "type": "string" }, "parameters": { @@ -14483,7 +14499,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" } }, @@ -15090,7 +15106,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" } }, @@ -15254,7 +15270,7 @@ "id": "GoogleCloudDialogflowV2beta1GcsDestination", "properties": { "uri": { - "description": "Required. The Google Cloud Storage URIs for the output. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", + "description": "Required. The Google Cloud Storage URIs for the output. A URI is of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", "type": "string" } }, @@ -15265,7 +15281,7 @@ "id": "GoogleCloudDialogflowV2beta1GcsSource", "properties": { "uri": { - "description": "Required. The Google Cloud Storage URIs for the inputs. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case.", + "description": "Required. The Google Cloud Storage URIs for the inputs. A URI is of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is used depends on the use case.", "type": "string" } }, @@ -15276,7 +15292,7 @@ "id": "GoogleCloudDialogflowV2beta1GcsSources", "properties": { "uris": { - "description": "Required. Google Cloud Storage URIs for the inputs. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case.", + "description": "Required. Google Cloud Storage URIs for the inputs. A URI is of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is used depends on the use case.", "items": { "type": "string" }, @@ -15827,7 +15843,7 @@ }, "phraseHints": { "deprecated": true, - "description": "A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [speech_contexts]() instead. If you specify both [phrase_hints]() and [speech_contexts](), Dialogflow will treat the [phrase_hints]() as a single additional [SpeechContext]().", + "description": "A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`]().", "items": { "type": "string" }, @@ -17852,7 +17868,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" }, "queryText": { @@ -18643,7 +18659,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "In Dialogflow assist for v3, the user can submit a form by sending a SuggestionInput. The form is uniquely determined by the answer_record field, which identifies a v3 QueryResult containing the current page. The form parameters are specified via the parameters field. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "In Dialogflow assist for v3, the user can submit a form by sending a SuggestionInput. The form is uniquely determined by the answer_record field, which identifies a v3 QueryResult containing the current page. The form parameters are specified via the parameters field. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" }, "textOverride": { @@ -18838,7 +18854,7 @@ "id": "GoogleCloudDialogflowV2beta1ValidationError", "properties": { "entries": { - "description": "The names of the entries that the error is associated with. Format: - \"projects//agent\", if the error is associated with the entire agent. - \"projects//agent/intents/\", if the error is associated with certain intents. - \"projects//agent/intents//trainingPhrases/\", if the error is associated with certain intent training phrases. - \"projects//agent/intents//parameters/\", if the error is associated with certain intent parameters. - \"projects//agent/entities/\", if the error is associated with certain entities.", + "description": "The names of the entries that the error is associated with. Format: - `projects//agent`, if the error is associated with the entire agent. - `projects//agent/intents/`, if the error is associated with certain intents. - `projects//agent/intents//trainingPhrases/`, if the error is associated with certain intent training phrases. - `projects//agent/intents//parameters/`, if the error is associated with certain intent parameters. - `projects//agent/entities/`, if the error is associated with certain entities.", "items": { "type": "string" }, diff --git a/dialogflow/v2beta1/dialogflow-gen.go b/dialogflow/v2beta1/dialogflow-gen.go index 728e66a185d..d3c75f41ed0 100644 --- a/dialogflow/v2beta1/dialogflow-gen.go +++ b/dialogflow/v2beta1/dialogflow-gen.go @@ -1541,7 +1541,7 @@ type GoogleCloudDialogflowCxV3ExportAgentResponse struct { AgentUri string `json:"agentUri,omitempty"` // CommitSha: Commit SHA of the git push. This field is populated if - // `git_destination` are specified in ExportAgentRequest. + // `git_destination` is specified in ExportAgentRequest. CommitSha string `json:"commitSha,omitempty"` // ForceSendFields is a list of field names (e.g. "AgentContent") to @@ -2896,6 +2896,17 @@ type GoogleCloudDialogflowCxV3ResponseMessage struct { // any way. PlayAudio *GoogleCloudDialogflowCxV3ResponseMessagePlayAudio `json:"playAudio,omitempty"` + // ResponseType: Response type. + // + // Possible values: + // "RESPONSE_TYPE_UNSPECIFIED" - Not specified. + // "ENTRY_PROMPT" - The response is from an entry prompt in the page. + // "PARAMETER_PROMPT" - The response is from form-filling prompt in + // the page. + // "HANDLER_PROMPT" - The response is from a transition route or an + // event handler in the page or flow or transition route group. + ResponseType string `json:"responseType,omitempty"` + // TelephonyTransferCall: A signal that the client should transfer the // phone call connected to this agent to a third-party endpoint. TelephonyTransferCall *GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall `json:"telephonyTransferCall,omitempty"` @@ -5118,7 +5129,7 @@ type GoogleCloudDialogflowCxV3beta1ExportAgentResponse struct { AgentUri string `json:"agentUri,omitempty"` // CommitSha: Commit SHA of the git push. This field is populated if - // `git_destination` are specified in ExportAgentRequest. + // `git_destination` is specified in ExportAgentRequest. CommitSha string `json:"commitSha,omitempty"` // ForceSendFields is a list of field names (e.g. "AgentContent") to @@ -8233,7 +8244,7 @@ type GoogleCloudDialogflowV2Context struct { // `projects//agent/sessions//contexts/`, or // `projects//agent/environments//users//sessions//contexts/`. The // `Context ID` is always converted to lowercase, may only contain - // characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If + // characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If // `Environment ID` is not specified, we assume default 'draft' // environment. If `User ID` is not specified, we assume default '-' // user. The following context names are reserved for internal use by @@ -8245,13 +8256,14 @@ type GoogleCloudDialogflowV2Context struct { // Parameters: Optional. The collection of parameters associated with // this context. Depending on your protocol or client library language, // this is a map, associative array, symbol table, dictionary, or JSON - // object composed of a collection of (MapKey, MapValue) pairs: - MapKey - // type: string - MapKey value: parameter name - MapValue type: - If - // parameter's entity type is a composite entity: map - Else: depending - // on parameter value type, could be one of string, number, boolean, - // null, list or map - MapValue value: - If parameter's entity type is a - // composite entity: map from composite entity property names to - // property values - Else: parameter value + // object composed of a collection of (MapKey, MapValue) pairs: * MapKey + // type: string * MapKey value: parameter name * MapValue type: If + // parameter's entity type is a composite entity then use map, + // otherwise, depending on the parameter value type, it could be one of + // string, number, boolean, null, list or map. * MapValue value: If + // parameter's entity type is a composite entity then use map from + // composite entity property names to property values, otherwise, use + // parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "LifespanCount") to @@ -8756,13 +8768,13 @@ type GoogleCloudDialogflowV2EventInput struct { // Parameters: The collection of parameters associated with the event. // Depending on your protocol or client library language, this is a map, // associative array, symbol table, dictionary, or JSON object composed - // of a collection of (MapKey, MapValue) pairs: - MapKey type: string - - // MapKey value: parameter name - MapValue type: - If parameter's entity - // type is a composite entity: map - Else: depending on parameter value - // type, could be one of string, number, boolean, null, list or map - - // MapValue value: - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - Else: - // parameter value + // of a collection of (MapKey, MapValue) pairs: * MapKey type: string * + // MapKey value: parameter name * MapValue type: If parameter's entity + // type is a composite entity then use map, otherwise, depending on the + // parameter value type, it could be one of string, number, boolean, + // null, list or map. * MapValue value: If parameter's entity type is a + // composite entity then use map from composite entity property names to + // property values, otherwise, use parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "LanguageCode") to @@ -8921,7 +8933,7 @@ func (s *GoogleCloudDialogflowV2FaqAnswer) UnmarshalJSON(data []byte) error { // for the output. type GoogleCloudDialogflowV2GcsDestination struct { // Uri: The Google Cloud Storage URIs for the output. A URI is of the - // form: gs://bucket/object-prefix-or-name Whether a prefix or name is + // form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is // used depends on the use case. The requesting user must have // "write-permission" to the bucket. Uri string `json:"uri,omitempty"` @@ -10796,13 +10808,13 @@ type GoogleCloudDialogflowV2QueryResult struct { // Parameters: The collection of extracted parameters. Depending on your // protocol or client library language, this is a map, associative // array, symbol table, dictionary, or JSON object composed of a - // collection of (MapKey, MapValue) pairs: - MapKey type: string - - // MapKey value: parameter name - MapValue type: - If parameter's entity - // type is a composite entity: map - Else: depending on parameter value - // type, could be one of string, number, boolean, null, list or map - - // MapValue value: - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - Else: - // parameter value + // collection of (MapKey, MapValue) pairs: * MapKey type: string * + // MapKey value: parameter name * MapValue type: If parameter's entity + // type is a composite entity then use map, otherwise, depending on the + // parameter value type, it could be one of string, number, boolean, + // null, list or map. * MapValue value: If parameter's entity type is a + // composite entity then use map from composite entity property names to + // property values, otherwise, use parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // QueryText: The original conversational query text: - If natural @@ -11824,9 +11836,9 @@ type GoogleCloudDialogflowV2beta1AnalyzeContentRequest struct { // MessageSendTime: Optional. The send time of the message from end user // or human agent's perspective. It is used for identifying the same // message under one participant. Given two messages under the same - // participant: - If send time are different regardless of whether the + // participant: * If send time are different regardless of whether the // content of the messages are exactly the same, the conversation will - // regard them as two distinct messages sent by the participant. - If + // regard them as two distinct messages sent by the participant. * If // send time is the same regardless of whether the content of the // messages are exactly the same, the conversation will regard them as // same message, and ignore the message received later. If the value is @@ -12397,13 +12409,13 @@ func (s *GoogleCloudDialogflowV2beta1AutomatedAgentReply) UnmarshalJSON(data []b // expected in this phase. The client provides this configuration in // terms of the durations of those two phases. The durations are // measured in terms of the audio length fromt the the start of the -// input audio. The flow goes like below: --> Time without speech +// input audio. The flow goes like below: ``` --> Time without speech // detection | utterance only | utterance or no-speech event | | // +-------------+ | +------------+ | +---------------+ ----------+ no // barge-in +-|-+ barge-in +-|-+ normal period +----------- -// +-------------+ | +------------+ | +---------------+ No-speech event -// is a response with END_OF_UTTERANCE without any transcript following -// up. +// +-------------+ | +------------+ | +---------------+ ``` No-speech +// event is a response with END_OF_UTTERANCE without any transcript +// following up. type GoogleCloudDialogflowV2beta1BargeInConfig struct { // NoBargeInDuration: Duration that is not eligible for barge-in at the // beginning of the input audio. @@ -13059,7 +13071,7 @@ type GoogleCloudDialogflowV2beta1Context struct { // `projects//agent/environments//users//sessions//contexts/`, - // `projects//locations//agent/environments//users//sessions//contexts/`, // The `Context ID` is always converted to lowercase, may only contain - // characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If + // characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If // `Environment ID` is not specified, we assume default 'draft' // environment. If `User ID` is not specified, we assume default '-' // user. The following context names are reserved for internal use by @@ -13071,13 +13083,14 @@ type GoogleCloudDialogflowV2beta1Context struct { // Parameters: Optional. The collection of parameters associated with // this context. Depending on your protocol or client library language, // this is a map, associative array, symbol table, dictionary, or JSON - // object composed of a collection of (MapKey, MapValue) pairs: - MapKey - // type: string - MapKey value: parameter name - MapValue type: - If - // parameter's entity type is a composite entity: map - Else: depending - // on parameter value type, could be one of string, number, boolean, - // null, list or map - MapValue value: - If parameter's entity type is a - // composite entity: map from composite entity property names to - // property values - Else: parameter value + // object composed of a collection of (MapKey, MapValue) pairs: * MapKey + // type: string * MapKey value: parameter name * MapValue type: If + // parameter's entity type is a composite entity then use map, + // otherwise, depending on the parameter value type, it could be one of + // string, number, boolean, null, list or map. * MapValue value: If + // parameter's entity type is a composite entity then use map from + // composite entity property names to property values, otherwise, use + // parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -14086,13 +14099,13 @@ type GoogleCloudDialogflowV2beta1EventInput struct { // Parameters: The collection of parameters associated with the event. // Depending on your protocol or client library language, this is a map, // associative array, symbol table, dictionary, or JSON object composed - // of a collection of (MapKey, MapValue) pairs: - MapKey type: string - - // MapKey value: parameter name - MapValue type: - If parameter's entity - // type is a composite entity: map - Else: depending on parameter value - // type, could be one of string, number, boolean, null, list or map - - // MapValue value: - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - Else: - // parameter value + // of a collection of (MapKey, MapValue) pairs: * MapKey type: string * + // MapKey value: parameter name * MapValue type: If parameter's entity + // type is a composite entity then use map, otherwise, depending on the + // parameter value type, it could be one of string, number, boolean, + // null, list or map. * MapValue value: If parameter's entity type is a + // composite entity then use map from composite entity property names to + // property values, otherwise, use parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "LanguageCode") to @@ -14430,7 +14443,7 @@ func (s *GoogleCloudDialogflowV2beta1FulfillmentGenericWebService) MarshalJSON() // location for the output. type GoogleCloudDialogflowV2beta1GcsDestination struct { // Uri: Required. The Google Cloud Storage URIs for the output. A URI is - // of the form: gs://bucket/object-prefix-or-name Whether a prefix or + // of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or // name is used depends on the use case. The requesting user must have // "write-permission" to the bucket. Uri string `json:"uri,omitempty"` @@ -14462,7 +14475,7 @@ func (s *GoogleCloudDialogflowV2beta1GcsDestination) MarshalJSON() ([]byte, erro // for single input. type GoogleCloudDialogflowV2beta1GcsSource struct { // Uri: Required. The Google Cloud Storage URIs for the inputs. A URI is - // of the form: gs://bucket/object-prefix-or-name Whether a prefix or + // of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or // name is used depends on the use case. Uri string `json:"uri,omitempty"` @@ -14493,8 +14506,8 @@ func (s *GoogleCloudDialogflowV2beta1GcsSource) MarshalJSON() ([]byte, error) { // locations for the inputs. type GoogleCloudDialogflowV2beta1GcsSources struct { // Uris: Required. Google Cloud Storage URIs for the inputs. A URI is of - // the form: gs://bucket/object-prefix-or-name Whether a prefix or name - // is used depends on the use case. + // the form: `gs://bucket/object-prefix-or-name` Whether a prefix or + // name is used depends on the use case. Uris []string `json:"uris,omitempty"` // ForceSendFields is a list of field names (e.g. "Uris") to @@ -15659,9 +15672,9 @@ type GoogleCloudDialogflowV2beta1InputAudioConfig struct { // Cloud Speech documentation // (https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) // for more details. This field is deprecated. Please use - // speech_contexts () instead. If you specify both phrase_hints () and - // speech_contexts (), Dialogflow will treat the phrase_hints () as a - // single additional SpeechContext (). + // `speech_contexts` () instead. If you specify both `phrase_hints` () + // and `speech_contexts` (), Dialogflow will treat the `phrase_hints` () + // as a single additional `SpeechContext` (). PhraseHints []string `json:"phraseHints,omitempty"` // SampleRateHertz: Required. Sample rate (in Hertz) of the audio @@ -19120,13 +19133,13 @@ type GoogleCloudDialogflowV2beta1QueryResult struct { // Parameters: The collection of extracted parameters. Depending on your // protocol or client library language, this is a map, associative // array, symbol table, dictionary, or JSON object composed of a - // collection of (MapKey, MapValue) pairs: - MapKey type: string - - // MapKey value: parameter name - MapValue type: - If parameter's entity - // type is a composite entity: map - Else: depending on parameter value - // type, could be one of string, number, boolean, null, list or map - - // MapValue value: - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - Else: - // parameter value + // collection of (MapKey, MapValue) pairs: * MapKey type: string * + // MapKey value: parameter name * MapValue type: If parameter's entity + // type is a composite entity then use map, otherwise, depending on the + // parameter value type, it could be one of string, number, boolean, + // null, list or map. * MapValue value: If parameter's entity type is a + // composite entity then use map from composite entity property names to + // property values, otherwise, use parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // QueryText: The original conversational query text: - If natural @@ -20693,13 +20706,13 @@ type GoogleCloudDialogflowV2beta1SuggestionInput struct { // current page. The form parameters are specified via the parameters // field. Depending on your protocol or client library language, this is // a map, associative array, symbol table, dictionary, or JSON object - // composed of a collection of (MapKey, MapValue) pairs: - MapKey type: - // string - MapKey value: parameter name - MapValue type: - If - // parameter's entity type is a composite entity: map - Else: depending - // on parameter value type, could be one of string, number, boolean, - // null, list or map - MapValue value: - If parameter's entity type is a - // composite entity: map from composite entity property names to - // property values - Else: parameter value + // composed of a collection of (MapKey, MapValue) pairs: * MapKey type: + // string * MapKey value: parameter name * MapValue type: If parameter's + // entity type is a composite entity then use map, otherwise, depending + // on the parameter value type, it could be one of string, number, + // boolean, null, list or map. * MapValue value: If parameter's entity + // type is a composite entity then use map from composite entity + // property names to property values, otherwise, use parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // TextOverride: Optional. If the customer edited the suggestion before @@ -21019,13 +21032,13 @@ type GoogleCloudDialogflowV2beta1TrainAgentRequest struct { // validation error. type GoogleCloudDialogflowV2beta1ValidationError struct { // Entries: The names of the entries that the error is associated with. - // Format: - "projects//agent", if the error is associated with the - // entire agent. - "projects//agent/intents/", if the error is + // Format: - `projects//agent`, if the error is associated with the + // entire agent. - `projects//agent/intents/`, if the error is // associated with certain intents. - - // "projects//agent/intents//trainingPhrases/", if the error is + // `projects//agent/intents//trainingPhrases/`, if the error is // associated with certain intent training phrases. - - // "projects//agent/intents//parameters/", if the error is associated - // with certain intent parameters. - "projects//agent/entities/", if the + // `projects//agent/intents//parameters/`, if the error is associated + // with certain intent parameters. - `projects//agent/entities/`, if the // error is associated with certain entities. Entries []string `json:"entries,omitempty"` @@ -27623,7 +27636,7 @@ type ProjectsAgentEnvironmentsUsersSessionsContextsPatchCall struct { // `projects//agent/environments//users//sessions//contexts/`, - // `projects//locations//agent/environments//users//sessions//contexts/ // `, The `Context ID` is always converted to lowercase, may only -// contain characters in a-zA-Z0-9_-% and may be at most 250 bytes +// contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes // long. If `Environment ID` is not specified, we assume default // 'draft' environment. If `User ID` is not specified, we assume // default '-' user. The following context names are reserved for @@ -27745,7 +27758,7 @@ func (c *ProjectsAgentEnvironmentsUsersSessionsContextsPatchCall) Do(opts ...goo // ], // "parameters": { // "name": { - // "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + // "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", // "location": "path", // "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", // "required": true, @@ -32709,7 +32722,7 @@ type ProjectsAgentSessionsContextsPatchCall struct { // `projects//agent/environments//users//sessions//contexts/`, - // `projects//locations//agent/environments//users//sessions//contexts/ // `, The `Context ID` is always converted to lowercase, may only -// contain characters in a-zA-Z0-9_-% and may be at most 250 bytes +// contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes // long. If `Environment ID` is not specified, we assume default // 'draft' environment. If `User ID` is not specified, we assume // default '-' user. The following context names are reserved for @@ -32831,7 +32844,7 @@ func (c *ProjectsAgentSessionsContextsPatchCall) Do(opts ...googleapi.CallOption // ], // "parameters": { // "name": { - // "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + // "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", // "location": "path", // "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", // "required": true, @@ -36300,7 +36313,7 @@ func (r *ProjectsConversationsService) Create(parentid string, googleclouddialog // Identifier of the conversation. Generally it's auto generated by // Google. Only set it if you cannot wait for the response to return a // auto-generated one to you. The conversation ID must be compliant with -// the regression fomula "a-zA-Z*" with the characters length in range +// the regression fomula `a-zA-Z*` with the characters length in range // of [3,64]. If the field is provided, the caller is resposible for 1. // the uniqueness of the ID, otherwise the request will be rejected. 2. // the consistency for whether to use custom ID or not under a project @@ -36412,7 +36425,7 @@ func (c *ProjectsConversationsCreateCall) Do(opts ...googleapi.CallOption) (*Goo // ], // "parameters": { // "conversationId": { - // "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula \"a-zA-Z*\" with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", + // "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", // "location": "query", // "type": "string" // }, @@ -46918,7 +46931,7 @@ type ProjectsLocationsAgentEnvironmentsUsersSessionsContextsPatchCall struct { // `projects//agent/environments//users//sessions//contexts/`, - // `projects//locations//agent/environments//users//sessions//contexts/ // `, The `Context ID` is always converted to lowercase, may only -// contain characters in a-zA-Z0-9_-% and may be at most 250 bytes +// contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes // long. If `Environment ID` is not specified, we assume default // 'draft' environment. If `User ID` is not specified, we assume // default '-' user. The following context names are reserved for @@ -47040,7 +47053,7 @@ func (c *ProjectsLocationsAgentEnvironmentsUsersSessionsContextsPatchCall) Do(op // ], // "parameters": { // "name": { - // "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + // "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", // "required": true, @@ -50169,7 +50182,7 @@ type ProjectsLocationsAgentSessionsContextsPatchCall struct { // `projects//agent/environments//users//sessions//contexts/`, - // `projects//locations//agent/environments//users//sessions//contexts/ // `, The `Context ID` is always converted to lowercase, may only -// contain characters in a-zA-Z0-9_-% and may be at most 250 bytes +// contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes // long. If `Environment ID` is not specified, we assume default // 'draft' environment. If `User ID` is not specified, we assume // default '-' user. The following context names are reserved for @@ -50291,7 +50304,7 @@ func (c *ProjectsLocationsAgentSessionsContextsPatchCall) Do(opts ...googleapi.C // ], // "parameters": { // "name": { - // "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + // "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", // "required": true, @@ -53760,7 +53773,7 @@ func (r *ProjectsLocationsConversationsService) Create(parentid string, googlecl // Identifier of the conversation. Generally it's auto generated by // Google. Only set it if you cannot wait for the response to return a // auto-generated one to you. The conversation ID must be compliant with -// the regression fomula "a-zA-Z*" with the characters length in range +// the regression fomula `a-zA-Z*` with the characters length in range // of [3,64]. If the field is provided, the caller is resposible for 1. // the uniqueness of the ID, otherwise the request will be rejected. 2. // the consistency for whether to use custom ID or not under a project @@ -53872,7 +53885,7 @@ func (c *ProjectsLocationsConversationsCreateCall) Do(opts ...googleapi.CallOpti // ], // "parameters": { // "conversationId": { - // "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula \"a-zA-Z*\" with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", + // "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", // "location": "query", // "type": "string" // }, diff --git a/dialogflow/v3/dialogflow-api.json b/dialogflow/v3/dialogflow-api.json index 0fee9a4b3d1..4469123ed1c 100644 --- a/dialogflow/v3/dialogflow-api.json +++ b/dialogflow/v3/dialogflow-api.json @@ -3820,7 +3820,7 @@ } } }, - "revision": "20230705", + "revision": "20230711", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -3963,7 +3963,7 @@ "type": "string" }, "trackingBranch": { - "description": "The branch of GitHub repository tracked for this agent.", + "description": "The branch of the GitHub repository tracked for this agent.", "type": "string" } }, @@ -5025,7 +5025,7 @@ "type": "string" }, "commitSha": { - "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "description": "Commit SHA of the git push. This field is populated if `git_destination` is specified in ExportAgentRequest.", "type": "string" } }, @@ -6664,6 +6664,22 @@ "$ref": "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio", "description": "Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way." }, + "responseType": { + "description": "Response type.", + "enum": [ + "RESPONSE_TYPE_UNSPECIFIED", + "ENTRY_PROMPT", + "PARAMETER_PROMPT", + "HANDLER_PROMPT" + ], + "enumDescriptions": [ + "Not specified.", + "The response is from an entry prompt in the page.", + "The response is from form-filling prompt in the page.", + "The response is from a transition route or an event handler in the page or flow or transition route group." + ], + "type": "string" + }, "telephonyTransferCall": { "$ref": "GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall", "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." @@ -8644,7 +8660,7 @@ "type": "string" }, "commitSha": { - "description": "Commit SHA of the git push. This field is populated if `git_destination` are specified in ExportAgentRequest.", + "description": "Commit SHA of the git push. This field is populated if `git_destination` is specified in ExportAgentRequest.", "type": "string" } }, @@ -10339,7 +10355,7 @@ "type": "integer" }, "name": { - "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "type": "string" }, "parameters": { @@ -10347,7 +10363,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" } }, @@ -10675,7 +10691,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" } }, @@ -10748,7 +10764,7 @@ "id": "GoogleCloudDialogflowV2GcsDestination", "properties": { "uri": { - "description": "The Google Cloud Storage URIs for the output. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", + "description": "The Google Cloud Storage URIs for the output. A URI is of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", "type": "string" } }, @@ -11950,7 +11966,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" }, "queryText": { @@ -12452,7 +12468,7 @@ "type": "integer" }, "name": { - "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "type": "string" }, "parameters": { @@ -12460,7 +12476,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" } }, @@ -12613,7 +12629,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" } }, @@ -12686,7 +12702,7 @@ "id": "GoogleCloudDialogflowV2beta1GcsDestination", "properties": { "uri": { - "description": "Required. The Google Cloud Storage URIs for the output. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", + "description": "Required. The Google Cloud Storage URIs for the output. A URI is of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", "type": "string" } }, @@ -14212,7 +14228,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object" }, "queryText": { diff --git a/dialogflow/v3/dialogflow-gen.go b/dialogflow/v3/dialogflow-gen.go index 44e64fcc0b2..513e54a1825 100644 --- a/dialogflow/v3/dialogflow-gen.go +++ b/dialogflow/v3/dialogflow-gen.go @@ -671,7 +671,7 @@ type GoogleCloudDialogflowCxV3AgentGitIntegrationSettingsGithubSettings struct { // RepositoryUri: The GitHub repository URI related to the agent. RepositoryUri string `json:"repositoryUri,omitempty"` - // TrackingBranch: The branch of GitHub repository tracked for this + // TrackingBranch: The branch of the GitHub repository tracked for this // agent. TrackingBranch string `json:"trackingBranch,omitempty"` @@ -2576,7 +2576,7 @@ type GoogleCloudDialogflowCxV3ExportAgentResponse struct { AgentUri string `json:"agentUri,omitempty"` // CommitSha: Commit SHA of the git push. This field is populated if - // `git_destination` are specified in ExportAgentRequest. + // `git_destination` is specified in ExportAgentRequest. CommitSha string `json:"commitSha,omitempty"` // ForceSendFields is a list of field names (e.g. "AgentContent") to @@ -5766,6 +5766,17 @@ type GoogleCloudDialogflowCxV3ResponseMessage struct { // any way. PlayAudio *GoogleCloudDialogflowCxV3ResponseMessagePlayAudio `json:"playAudio,omitempty"` + // ResponseType: Response type. + // + // Possible values: + // "RESPONSE_TYPE_UNSPECIFIED" - Not specified. + // "ENTRY_PROMPT" - The response is from an entry prompt in the page. + // "PARAMETER_PROMPT" - The response is from form-filling prompt in + // the page. + // "HANDLER_PROMPT" - The response is from a transition route or an + // event handler in the page or flow or transition route group. + ResponseType string `json:"responseType,omitempty"` + // TelephonyTransferCall: A signal that the client should transfer the // phone call connected to this agent to a third-party endpoint. TelephonyTransferCall *GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall `json:"telephonyTransferCall,omitempty"` @@ -9382,7 +9393,7 @@ type GoogleCloudDialogflowCxV3beta1ExportAgentResponse struct { AgentUri string `json:"agentUri,omitempty"` // CommitSha: Commit SHA of the git push. This field is populated if - // `git_destination` are specified in ExportAgentRequest. + // `git_destination` is specified in ExportAgentRequest. CommitSha string `json:"commitSha,omitempty"` // ForceSendFields is a list of field names (e.g. "AgentContent") to @@ -12497,7 +12508,7 @@ type GoogleCloudDialogflowV2Context struct { // `projects//agent/sessions//contexts/`, or // `projects//agent/environments//users//sessions//contexts/`. The // `Context ID` is always converted to lowercase, may only contain - // characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If + // characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If // `Environment ID` is not specified, we assume default 'draft' // environment. If `User ID` is not specified, we assume default '-' // user. The following context names are reserved for internal use by @@ -12509,13 +12520,14 @@ type GoogleCloudDialogflowV2Context struct { // Parameters: Optional. The collection of parameters associated with // this context. Depending on your protocol or client library language, // this is a map, associative array, symbol table, dictionary, or JSON - // object composed of a collection of (MapKey, MapValue) pairs: - MapKey - // type: string - MapKey value: parameter name - MapValue type: - If - // parameter's entity type is a composite entity: map - Else: depending - // on parameter value type, could be one of string, number, boolean, - // null, list or map - MapValue value: - If parameter's entity type is a - // composite entity: map from composite entity property names to - // property values - Else: parameter value + // object composed of a collection of (MapKey, MapValue) pairs: * MapKey + // type: string * MapKey value: parameter name * MapValue type: If + // parameter's entity type is a composite entity then use map, + // otherwise, depending on the parameter value type, it could be one of + // string, number, boolean, null, list or map. * MapValue value: If + // parameter's entity type is a composite entity then use map from + // composite entity property names to property values, otherwise, use + // parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "LifespanCount") to @@ -13020,13 +13032,13 @@ type GoogleCloudDialogflowV2EventInput struct { // Parameters: The collection of parameters associated with the event. // Depending on your protocol or client library language, this is a map, // associative array, symbol table, dictionary, or JSON object composed - // of a collection of (MapKey, MapValue) pairs: - MapKey type: string - - // MapKey value: parameter name - MapValue type: - If parameter's entity - // type is a composite entity: map - Else: depending on parameter value - // type, could be one of string, number, boolean, null, list or map - - // MapValue value: - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - Else: - // parameter value + // of a collection of (MapKey, MapValue) pairs: * MapKey type: string * + // MapKey value: parameter name * MapValue type: If parameter's entity + // type is a composite entity then use map, otherwise, depending on the + // parameter value type, it could be one of string, number, boolean, + // null, list or map. * MapValue value: If parameter's entity type is a + // composite entity then use map from composite entity property names to + // property values, otherwise, use parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "LanguageCode") to @@ -13185,7 +13197,7 @@ func (s *GoogleCloudDialogflowV2FaqAnswer) UnmarshalJSON(data []byte) error { // for the output. type GoogleCloudDialogflowV2GcsDestination struct { // Uri: The Google Cloud Storage URIs for the output. A URI is of the - // form: gs://bucket/object-prefix-or-name Whether a prefix or name is + // form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is // used depends on the use case. The requesting user must have // "write-permission" to the bucket. Uri string `json:"uri,omitempty"` @@ -15060,13 +15072,13 @@ type GoogleCloudDialogflowV2QueryResult struct { // Parameters: The collection of extracted parameters. Depending on your // protocol or client library language, this is a map, associative // array, symbol table, dictionary, or JSON object composed of a - // collection of (MapKey, MapValue) pairs: - MapKey type: string - - // MapKey value: parameter name - MapValue type: - If parameter's entity - // type is a composite entity: map - Else: depending on parameter value - // type, could be one of string, number, boolean, null, list or map - - // MapValue value: - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - Else: - // parameter value + // collection of (MapKey, MapValue) pairs: * MapKey type: string * + // MapKey value: parameter name * MapValue type: If parameter's entity + // type is a composite entity then use map, otherwise, depending on the + // parameter value type, it could be one of string, number, boolean, + // null, list or map. * MapValue value: If parameter's entity type is a + // composite entity then use map from composite entity property names to + // property values, otherwise, use parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // QueryText: The original conversational query text: - If natural @@ -16013,7 +16025,7 @@ type GoogleCloudDialogflowV2beta1Context struct { // `projects//agent/environments//users//sessions//contexts/`, - // `projects//locations//agent/environments//users//sessions//contexts/`, // The `Context ID` is always converted to lowercase, may only contain - // characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If + // characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If // `Environment ID` is not specified, we assume default 'draft' // environment. If `User ID` is not specified, we assume default '-' // user. The following context names are reserved for internal use by @@ -16025,13 +16037,14 @@ type GoogleCloudDialogflowV2beta1Context struct { // Parameters: Optional. The collection of parameters associated with // this context. Depending on your protocol or client library language, // this is a map, associative array, symbol table, dictionary, or JSON - // object composed of a collection of (MapKey, MapValue) pairs: - MapKey - // type: string - MapKey value: parameter name - MapValue type: - If - // parameter's entity type is a composite entity: map - Else: depending - // on parameter value type, could be one of string, number, boolean, - // null, list or map - MapValue value: - If parameter's entity type is a - // composite entity: map from composite entity property names to - // property values - Else: parameter value + // object composed of a collection of (MapKey, MapValue) pairs: * MapKey + // type: string * MapKey value: parameter name * MapValue type: If + // parameter's entity type is a composite entity then use map, + // otherwise, depending on the parameter value type, it could be one of + // string, number, boolean, null, list or map. * MapValue value: If + // parameter's entity type is a composite entity then use map from + // composite entity property names to property values, otherwise, use + // parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "LifespanCount") to @@ -16293,13 +16306,13 @@ type GoogleCloudDialogflowV2beta1EventInput struct { // Parameters: The collection of parameters associated with the event. // Depending on your protocol or client library language, this is a map, // associative array, symbol table, dictionary, or JSON object composed - // of a collection of (MapKey, MapValue) pairs: - MapKey type: string - - // MapKey value: parameter name - MapValue type: - If parameter's entity - // type is a composite entity: map - Else: depending on parameter value - // type, could be one of string, number, boolean, null, list or map - - // MapValue value: - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - Else: - // parameter value + // of a collection of (MapKey, MapValue) pairs: * MapKey type: string * + // MapKey value: parameter name * MapValue type: If parameter's entity + // type is a composite entity then use map, otherwise, depending on the + // parameter value type, it could be one of string, number, boolean, + // null, list or map. * MapValue value: If parameter's entity type is a + // composite entity then use map from composite entity property names to + // property values, otherwise, use parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "LanguageCode") to @@ -16458,7 +16471,7 @@ func (s *GoogleCloudDialogflowV2beta1FaqAnswer) UnmarshalJSON(data []byte) error // location for the output. type GoogleCloudDialogflowV2beta1GcsDestination struct { // Uri: Required. The Google Cloud Storage URIs for the output. A URI is - // of the form: gs://bucket/object-prefix-or-name Whether a prefix or + // of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or // name is used depends on the use case. The requesting user must have // "write-permission" to the bucket. Uri string `json:"uri,omitempty"` @@ -18932,13 +18945,13 @@ type GoogleCloudDialogflowV2beta1QueryResult struct { // Parameters: The collection of extracted parameters. Depending on your // protocol or client library language, this is a map, associative // array, symbol table, dictionary, or JSON object composed of a - // collection of (MapKey, MapValue) pairs: - MapKey type: string - - // MapKey value: parameter name - MapValue type: - If parameter's entity - // type is a composite entity: map - Else: depending on parameter value - // type, could be one of string, number, boolean, null, list or map - - // MapValue value: - If parameter's entity type is a composite entity: - // map from composite entity property names to property values - Else: - // parameter value + // collection of (MapKey, MapValue) pairs: * MapKey type: string * + // MapKey value: parameter name * MapValue type: If parameter's entity + // type is a composite entity then use map, otherwise, depending on the + // parameter value type, it could be one of string, number, boolean, + // null, list or map. * MapValue value: If parameter's entity type is a + // composite entity then use map from composite entity property names to + // property values, otherwise, use parameter value. Parameters googleapi.RawMessage `json:"parameters,omitempty"` // QueryText: The original conversational query text: - If natural diff --git a/discovery/v1/discovery-api.json b/discovery/v1/discovery-api.json index 8d8df5dbdee..6d71e26750d 100644 --- a/discovery/v1/discovery-api.json +++ b/discovery/v1/discovery-api.json @@ -234,6 +234,10 @@ "description": "The default value of this property (if one exists).", "type": "string" }, + "deprecated": { + "description": "Whether the parameter is deprecated.", + "type": "boolean" + }, "description": { "description": "A description of this object.", "type": "string" @@ -245,6 +249,13 @@ }, "type": "array" }, + "enumDeprecated": { + "description": "The deprecation status for the enums. Each position maps to the corresponding value in the \"enum\" array.", + "items": { + "type": "boolean" + }, + "type": "array" + }, "enumDescriptions": { "description": "The descriptions for the enums. Each position maps to the corresponding value in the \"enum\" array.", "items": { @@ -518,6 +529,10 @@ "RestMethod": { "id": "RestMethod", "properties": { + "deprecated": { + "description": "Whether this method is deprecated.", + "type": "boolean" + }, "description": { "description": "Description of this method.", "type": "string" @@ -663,6 +678,10 @@ "RestResource": { "id": "RestResource", "properties": { + "deprecated": { + "description": "Whether this resource is deprecated.", + "type": "boolean" + }, "methods": { "additionalProperties": { "$ref": "RestMethod", diff --git a/discovery/v1/discovery-gen.go b/discovery/v1/discovery-gen.go index 1c0d0a3300c..9135f685848 100644 --- a/discovery/v1/discovery-gen.go +++ b/discovery/v1/discovery-gen.go @@ -283,12 +283,19 @@ type JsonSchema struct { // Default: The default value of this property (if one exists). Default string `json:"default,omitempty"` + // Deprecated -- Whether the parameter is deprecated. + Deprecated bool `json:"deprecated,omitempty"` + // Description: A description of this object. Description string `json:"description,omitempty"` // Enum: Values this parameter may take (if it is an enum). Enum []string `json:"enum,omitempty"` + // EnumDeprecated: The deprecation status for the enums. Each position + // maps to the corresponding value in the "enum" array. + EnumDeprecated []bool `json:"enumDeprecated,omitempty"` + // EnumDescriptions: The descriptions for the enums. Each position maps // to the corresponding value in the "enum" array. EnumDescriptions []string `json:"enumDescriptions,omitempty"` @@ -698,6 +705,9 @@ func (s *RestDescriptionIcons) MarshalJSON() ([]byte, error) { } type RestMethod struct { + // Deprecated -- Whether this method is deprecated. + Deprecated bool `json:"deprecated,omitempty"` + // Description: Description of this method. Description string `json:"description,omitempty"` @@ -755,7 +765,7 @@ type RestMethod struct { // if the method supports media download. UseMediaDownloadService bool `json:"useMediaDownloadService,omitempty"` - // ForceSendFields is a list of field names (e.g. "Description") to + // ForceSendFields is a list of field names (e.g. "Deprecated") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -763,10 +773,10 @@ type RestMethod struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Description") to include - // in API requests with the JSON null value. By default, fields with - // empty values are omitted from API requests. However, any field with - // an empty value appearing in NullFields will be sent to the server as + // NullFields is a list of field names (e.g. "Deprecated") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` @@ -975,13 +985,16 @@ func (s *RestMethodResponse) MarshalJSON() ([]byte, error) { } type RestResource struct { + // Deprecated -- Whether this resource is deprecated. + Deprecated bool `json:"deprecated,omitempty"` + // Methods: Methods on this resource. Methods map[string]RestMethod `json:"methods,omitempty"` // Resources: Sub-resources on this resource. Resources map[string]RestResource `json:"resources,omitempty"` - // ForceSendFields is a list of field names (e.g. "Methods") to + // ForceSendFields is a list of field names (e.g. "Deprecated") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -989,7 +1002,7 @@ type RestResource struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Methods") to include in + // NullFields is a list of field names (e.g. "Deprecated") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as diff --git a/displayvideo/v1/displayvideo-api.json b/displayvideo/v1/displayvideo-api.json index 31d6ae99346..3fcc33b568f 100644 --- a/displayvideo/v1/displayvideo-api.json +++ b/displayvideo/v1/displayvideo-api.json @@ -8152,7 +8152,7 @@ } } }, - "revision": "20230627", + "revision": "20230713", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -14226,7 +14226,7 @@ "description": "The bidding strategy of the insertion order. By default, fixed_bid is set." }, "billableOutcome": { - "description": "Immutable. The billable outcome of the insertion order.", + "description": "Immutable. The billable outcome of the insertion order. Outcome based buying will be deprecated on **August 1, 2023**. Read more on our [Announced Deprecations page](/display-video/api/deprecations#features.obb).", "enum": [ "BILLABLE_OUTCOME_UNSPECIFIED", "BILLABLE_OUTCOME_PAY_PER_IMPRESSION", diff --git a/displayvideo/v1/displayvideo-gen.go b/displayvideo/v1/displayvideo-gen.go index 10d799babff..4f81bee7cf4 100644 --- a/displayvideo/v1/displayvideo-gen.go +++ b/displayvideo/v1/displayvideo-gen.go @@ -9244,7 +9244,9 @@ type InsertionOrder struct { BidStrategy *BiddingStrategy `json:"bidStrategy,omitempty"` // BillableOutcome: Immutable. The billable outcome of the insertion - // order. + // order. Outcome based buying will be deprecated on **August 1, 2023**. + // Read more on our Announced Deprecations page + // (/display-video/api/deprecations#features.obb). // // Possible values: // "BILLABLE_OUTCOME_UNSPECIFIED" - Unspecified billable outcome. diff --git a/displayvideo/v2/displayvideo-api.json b/displayvideo/v2/displayvideo-api.json index 3e8575badd3..0a330013efd 100644 --- a/displayvideo/v2/displayvideo-api.json +++ b/displayvideo/v2/displayvideo-api.json @@ -9178,7 +9178,7 @@ } } }, - "revision": "20230627", + "revision": "20230713", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -15801,7 +15801,7 @@ "description": "The bidding strategy of the insertion order. By default, fixed_bid is set." }, "billableOutcome": { - "description": "Immutable. The billable outcome of the insertion order.", + "description": "Immutable. The billable outcome of the insertion order. Outcome based buying will be deprecated on **August 1, 2023**. Read more on our [Announced Deprecations page](/display-video/api/deprecations#features.obb).", "enum": [ "BILLABLE_OUTCOME_UNSPECIFIED", "BILLABLE_OUTCOME_PAY_PER_IMPRESSION", diff --git a/displayvideo/v2/displayvideo-gen.go b/displayvideo/v2/displayvideo-gen.go index f9e4c849f02..953600aeae0 100644 --- a/displayvideo/v2/displayvideo-gen.go +++ b/displayvideo/v2/displayvideo-gen.go @@ -10124,7 +10124,9 @@ type InsertionOrder struct { BidStrategy *BiddingStrategy `json:"bidStrategy,omitempty"` // BillableOutcome: Immutable. The billable outcome of the insertion - // order. + // order. Outcome based buying will be deprecated on **August 1, 2023**. + // Read more on our Announced Deprecations page + // (/display-video/api/deprecations#features.obb). // // Possible values: // "BILLABLE_OUTCOME_UNSPECIFIED" - Unspecified billable outcome. diff --git a/documentai/v1/documentai-api.json b/documentai/v1/documentai-api.json index 7664f89d9af..f42d4de0afe 100644 --- a/documentai/v1/documentai-api.json +++ b/documentai/v1/documentai-api.json @@ -1042,7 +1042,7 @@ } } }, - "revision": "20230619", + "revision": "20230706", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -1145,6 +1145,7 @@ "description": "The basic metadata of the long running operation." }, "destDatasetType": { + "deprecated": true, "description": "The destination dataset split type.", "enum": [ "DATASET_SPLIT_TYPE_UNSPECIFIED", @@ -1354,6 +1355,7 @@ "id": "GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId", "properties": { "cwDocId": { + "deprecated": true, "description": "Id of the document (indexed) managed by Content Warehouse.", "type": "string" }, @@ -1567,6 +1569,10 @@ "description": "The source Cloud Storage URI of the document.", "type": "string" }, + "outputDocumentId": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", + "description": "The document id of imported document if it was successful, otherwise empty." + }, "outputGcsDestination": { "description": "The output_gcs_destination of the processed document if it was successful, otherwise empty.", "type": "string" @@ -1737,6 +1743,14 @@ "description": "Response of the sample documents operation.", "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse", "properties": { + "sampleTestStatus": { + "$ref": "GoogleRpcStatus", + "description": "The status of sampling documents in test split." + }, + "sampleTrainingStatus": { + "$ref": "GoogleRpcStatus", + "description": "The status of sampling documents in training split." + }, "selectedDocuments": { "description": "The result of the sampling process.", "items": { @@ -2003,6 +2017,10 @@ "$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", "description": "The input documents for the BatchProcessDocuments method." }, + "processOptions": { + "$ref": "GoogleCloudDocumentaiV1ProcessOptions", + "description": "Inference-time options for the process API" + }, "skipHumanReview": { "description": "Whether human review should be skipped for this request. Default to `false`.", "type": "boolean" @@ -2211,6 +2229,7 @@ "type": "array" }, "textStyles": { + "deprecated": true, "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1DocumentStyle" @@ -2456,6 +2475,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", + "deprecated": true, "description": "The history of this page." }, "symbols": { @@ -2524,6 +2544,7 @@ "type": "number" }, "layoutId": { + "deprecated": true, "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", "type": "string" }, @@ -2576,6 +2597,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -2794,6 +2816,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -2843,6 +2866,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -2897,6 +2921,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", + "deprecated": true, "description": "The history of this table." } }, @@ -2965,6 +2990,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." }, "styleInfo": { @@ -3095,6 +3121,7 @@ "id": "GoogleCloudDocumentaiV1DocumentProvenance", "properties": { "id": { + "deprecated": true, "description": "The Id of this operation. Needs to be unique within the scope of the revision.", "format": "int32", "type": "integer" @@ -3107,6 +3134,7 @@ "type": "array" }, "revision": { + "deprecated": true, "description": "The index of the revision that produced this element.", "format": "int32", "type": "integer" @@ -3123,6 +3151,16 @@ "EVAL_APPROVED", "EVAL_SKIPPED" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + true, + true + ], "enumDescriptions": [ "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", "Add an element.", @@ -3143,6 +3181,7 @@ "id": "GoogleCloudDocumentaiV1DocumentProvenanceParent", "properties": { "id": { + "deprecated": true, "description": "The id of the parent provenance.", "format": "int32", "type": "integer" @@ -3182,6 +3221,7 @@ "type": "string" }, "parent": { + "deprecated": true, "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", "items": { "format": "int32", @@ -3468,6 +3508,7 @@ "type": "string" }, "provenance": { + "deprecated": true, "description": "The history of this annotation.", "items": { "$ref": "GoogleCloudDocumentaiV1DocumentProvenance" @@ -3933,6 +3974,65 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1OcrConfig": { + "description": "Config for Document OCR.", + "id": "GoogleCloudDocumentaiV1OcrConfig", + "properties": { + "advancedOcrOptions": { + "description": "A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "computeStyleInfo": { + "description": "Turn on font id model and returns font style information.", + "type": "boolean" + }, + "enableImageQualityScores": { + "description": "Enables intelligent document quality scores after OCR. Can help with diagnosing why OCR responses are of poor quality for a given input. Adds additional latency comparable to regular OCR to the process call.", + "type": "boolean" + }, + "enableNativePdfParsing": { + "description": "Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs.", + "type": "boolean" + }, + "enableSymbol": { + "description": "Includes symbol level OCR information if set to true.", + "type": "boolean" + }, + "hints": { + "$ref": "GoogleCloudDocumentaiV1OcrConfigHints", + "description": "Hints for the OCR model." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1OcrConfigHints": { + "description": "Hints for OCR Engine", + "id": "GoogleCloudDocumentaiV1OcrConfigHints", + "properties": { + "languageHints": { + "description": "List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting hints is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ProcessOptions": { + "description": "Options for Process API", + "id": "GoogleCloudDocumentaiV1ProcessOptions", + "properties": { + "ocrConfig": { + "$ref": "GoogleCloudDocumentaiV1OcrConfig", + "description": "Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1ProcessRequest": { "description": "Request message for the ProcessDocument method.", "id": "GoogleCloudDocumentaiV1ProcessRequest", @@ -3942,10 +4042,18 @@ "format": "google-fieldmask", "type": "string" }, + "gcsDocument": { + "$ref": "GoogleCloudDocumentaiV1GcsDocument", + "description": "A raw document on Google Cloud Storage." + }, "inlineDocument": { "$ref": "GoogleCloudDocumentaiV1Document", "description": "An inline document proto." }, + "processOptions": { + "$ref": "GoogleCloudDocumentaiV1ProcessOptions", + "description": "Inference-time options for the process API" + }, "rawDocument": { "$ref": "GoogleCloudDocumentaiV1RawDocument", "description": "A raw document content (bytes)." @@ -4591,6 +4699,7 @@ "type": "array" }, "textStyles": { + "deprecated": true, "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyle" @@ -4788,6 +4897,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this page." }, "symbols": { @@ -4856,6 +4966,7 @@ "type": "number" }, "layoutId": { + "deprecated": true, "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", "type": "string" }, @@ -4908,6 +5019,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -5126,6 +5238,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -5175,6 +5288,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -5229,6 +5343,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this table." } }, @@ -5297,6 +5412,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." }, "styleInfo": { @@ -5427,6 +5543,7 @@ "id": "GoogleCloudDocumentaiV1beta1DocumentProvenance", "properties": { "id": { + "deprecated": true, "description": "The Id of this operation. Needs to be unique within the scope of the revision.", "format": "int32", "type": "integer" @@ -5439,6 +5556,7 @@ "type": "array" }, "revision": { + "deprecated": true, "description": "The index of the revision that produced this element.", "format": "int32", "type": "integer" @@ -5455,6 +5573,16 @@ "EVAL_APPROVED", "EVAL_SKIPPED" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + true, + true + ], "enumDescriptions": [ "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", "Add an element.", @@ -5475,6 +5603,7 @@ "id": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent", "properties": { "id": { + "deprecated": true, "description": "The id of the parent provenance.", "format": "int32", "type": "integer" @@ -5514,6 +5643,7 @@ "type": "string" }, "parent": { + "deprecated": true, "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", "items": { "format": "int32", @@ -5671,6 +5801,7 @@ "type": "string" }, "provenance": { + "deprecated": true, "description": "The history of this annotation.", "items": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance" @@ -5949,6 +6080,7 @@ "type": "array" }, "textStyles": { + "deprecated": true, "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyle" @@ -6166,6 +6298,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this page." }, "symbols": { @@ -6234,6 +6367,7 @@ "type": "number" }, "layoutId": { + "deprecated": true, "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", "type": "string" }, @@ -6286,6 +6420,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -6504,6 +6639,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -6553,6 +6689,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -6607,6 +6744,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this table." } }, @@ -6675,6 +6813,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." }, "styleInfo": { @@ -6805,6 +6944,7 @@ "id": "GoogleCloudDocumentaiV1beta2DocumentProvenance", "properties": { "id": { + "deprecated": true, "description": "The Id of this operation. Needs to be unique within the scope of the revision.", "format": "int32", "type": "integer" @@ -6817,6 +6957,7 @@ "type": "array" }, "revision": { + "deprecated": true, "description": "The index of the revision that produced this element.", "format": "int32", "type": "integer" @@ -6833,6 +6974,16 @@ "EVAL_APPROVED", "EVAL_SKIPPED" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + true, + true + ], "enumDescriptions": [ "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", "Add an element.", @@ -6853,6 +7004,7 @@ "id": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent", "properties": { "id": { + "deprecated": true, "description": "The id of the parent provenance.", "format": "int32", "type": "integer" @@ -6892,6 +7044,7 @@ "type": "string" }, "parent": { + "deprecated": true, "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", "items": { "format": "int32", @@ -7049,6 +7202,7 @@ "type": "string" }, "provenance": { + "deprecated": true, "description": "The history of this annotation.", "items": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance" @@ -7210,6 +7364,54 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata": { + "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + }, + "errorDocumentCount": { + "description": "Total number of documents that failed to be deleted in storage.", + "format": "int32", + "type": "integer" + }, + "individualBatchDeleteStatuses": { + "description": "The list of response details of each document.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus" + }, + "type": "array" + }, + "totalDocumentCount": { + "description": "Total number of documents deleting from dataset.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus": { + "description": "The status of each individual document in the batch delete process.", + "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus", + "properties": { + "documentId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentId", + "description": "The document id of the document." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of deleting the document in storage." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse": { + "description": "Response of the delete documents operation.", + "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3BatchProcessMetadata": { "description": "The long-running operation metadata for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadata", @@ -7265,6 +7467,7 @@ "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus", "properties": { "humanReviewOperation": { + "deprecated": true, "description": "The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by the ReviewDocument method.", "type": "string" }, @@ -7338,6 +7541,89 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3Dataset": { + "description": "A singleton resource under a Processor which configures a collection of documents.", + "id": "GoogleCloudDocumentaiV1beta3Dataset", + "properties": { + "documentWarehouseConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig", + "description": "Optional. Document AI Warehouse-based dataset configuration." + }, + "gcsManagedConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig", + "description": "Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location." + }, + "name": { + "description": "Dataset resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset`", + "type": "string" + }, + "spannerIndexingConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig", + "description": "Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search." + }, + "state": { + "description": "Required. State of the dataset. Ignored when updating dataset.", + "enum": [ + "STATE_UNSPECIFIED", + "UNINITIALIZED", + "INITIALIZING", + "INITIALIZED" + ], + "enumDescriptions": [ + "Default unspecified enum, should not be used.", + "Dataset has not been initialized.", + "Dataset is being initialized.", + "Dataset has been initialized." + ], + "type": "string" + }, + "unmanagedDatasetConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig", + "description": "Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed)." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig": { + "description": "Configuration specific to the Document AI Warehouse-based implementation.", + "id": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig", + "properties": { + "collection": { + "description": "Output only. The collection in Document AI Warehouse associated with the dataset.", + "readOnly": true, + "type": "string" + }, + "schema": { + "description": "Output only. The schema in Document AI Warehouse associated with the dataset.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig": { + "description": "Configuration specific to the Cloud Storage-based implementation.", + "id": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig", + "properties": { + "gcsPrefix": { + "$ref": "GoogleCloudDocumentaiV1beta3GcsPrefix", + "description": "Required. The Cloud Storage URI (a directory) where the documents belonging to the dataset must be stored." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig": { + "description": "Configuration specific to spanner-based indexing.", + "id": "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig": { + "description": "Configuration specific to an unmanaged dataset.", + "id": "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata": { "description": "The long-running operation metadata for the DeleteProcessor method.", "id": "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata", @@ -7394,6 +7680,52 @@ "properties": {}, "type": "object" }, + "GoogleCloudDocumentaiV1beta3DocumentId": { + "description": "Document Identifier.", + "id": "GoogleCloudDocumentaiV1beta3DocumentId", + "properties": { + "gcsManagedDocId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId", + "description": "A document id within user-managed Cloud Storage." + }, + "revisionRef": { + "$ref": "GoogleCloudDocumentaiV1beta3RevisionRef", + "description": "Points to a specific revision of the document if set." + }, + "unmanagedDocId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId", + "description": "A document id within unmanaged dataset." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId": { + "description": "Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.", + "id": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId", + "properties": { + "cwDocId": { + "deprecated": true, + "description": "Id of the document (indexed) managed by Content Warehouse.", + "type": "string" + }, + "gcsUri": { + "description": "Required. The Cloud Storage URI where the actual document is stored.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId": { + "description": "Identifies a document uniquely within the scope of a dataset in unmanaged option.", + "id": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId", + "properties": { + "docId": { + "description": "Required. The id of the document.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": { "description": "The long-running operation metadata for the EnableProcessor method.", "id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata", @@ -7433,6 +7765,17 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3GcsPrefix": { + "description": "Specifies all documents on Cloud Storage with a common prefix.", + "id": "GoogleCloudDocumentaiV1beta3GcsPrefix", + "properties": { + "gcsUriPrefix": { + "description": "The URI prefix.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3HumanReviewStatus": { "description": "The status of human review on a processed document.", "id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", @@ -7466,6 +7809,76 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata": { + "description": "Metadata of the import document operation.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + }, + "importConfigValidationResults": { + "description": "Validation statuses of the batch documents import config.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult" + }, + "type": "array" + }, + "individualImportStatuses": { + "description": "The list of response details of each document.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus" + }, + "type": "array" + }, + "totalDocumentCount": { + "description": "Total number of the documents that are qualified for importing.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult": { + "description": "The validation status of each import config. Status is set to errors if there is no documents to import in the import_config, or OK if the operation will try to proceed at least one document.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult", + "properties": { + "inputGcsSource": { + "description": "The source Cloud Storage URI specified in the import config.", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The validation status of import config." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus": { + "description": "The status of each individual document in the import process.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus", + "properties": { + "inputGcsSource": { + "description": "The source Cloud Storage URI of the document.", + "type": "string" + }, + "outputDocumentId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentId", + "description": "The document id of imported document if it was successful, otherwise empty." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of the importing of the document." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse": { + "description": "Response of the import document operation.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": { "description": "The long-running operation metadata for the ImportProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata", @@ -7566,6 +7979,37 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3RevisionRef": { + "description": "The revision reference specifies which revision on the document to read.", + "id": "GoogleCloudDocumentaiV1beta3RevisionRef", + "properties": { + "latestProcessorVersion": { + "description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", + "type": "string" + }, + "revisionCase": { + "description": "Reads the revision by the predefined case.", + "enum": [ + "REVISION_CASE_UNSPECIFIED", + "LATEST_HUMAN_REVIEW", + "LATEST_TIMESTAMP", + "BASE_OCR_REVISION" + ], + "enumDescriptions": [ + "Unspecified case, fallback to read the LATEST_HUMAN_REVIEW.", + "The latest revision made by a human.", + "The latest revision based on timestamp.", + "The first (OCR) revision." + ], + "type": "string" + }, + "revisionId": { + "description": "Reads the revision given by the id.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata": { "description": "The long-running operation metadata for the SetDefaultProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata", @@ -7661,6 +8105,16 @@ "properties": {}, "type": "object" }, + "GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata": { + "id": "GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + } + }, + "type": "object" + }, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", diff --git a/documentai/v1/documentai-gen.go b/documentai/v1/documentai-gen.go index b5c4d944233..dd7453c6c8e 100644 --- a/documentai/v1/documentai-gen.go +++ b/documentai/v1/documentai-gen.go @@ -1199,6 +1199,10 @@ type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus // InputGcsSource: The source Cloud Storage URI of the document. InputGcsSource string `json:"inputGcsSource,omitempty"` + // OutputDocumentId: The document id of imported document if it was + // successful, otherwise empty. + OutputDocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"outputDocumentId,omitempty"` + // OutputGcsDestination: The output_gcs_destination of the processed // document if it was successful, otherwise empty. OutputGcsDestination string `json:"outputGcsDestination,omitempty"` @@ -1510,18 +1514,25 @@ func (s *GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata) MarshalJSON() ([ // GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse: Response of // the sample documents operation. type GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse struct { + // SampleTestStatus: The status of sampling documents in test split. + SampleTestStatus *GoogleRpcStatus `json:"sampleTestStatus,omitempty"` + + // SampleTrainingStatus: The status of sampling documents in training + // split. + SampleTrainingStatus *GoogleRpcStatus `json:"sampleTrainingStatus,omitempty"` + // SelectedDocuments: The result of the sampling process. SelectedDocuments []*GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument `json:"selectedDocuments,omitempty"` - // ForceSendFields is a list of field names (e.g. "SelectedDocuments") - // to unconditionally include in API requests. By default, fields with + // ForceSendFields is a list of field names (e.g. "SampleTestStatus") to + // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "SelectedDocuments") to + // NullFields is a list of field names (e.g. "SampleTestStatus") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the @@ -2027,6 +2038,9 @@ type GoogleCloudDocumentaiV1BatchProcessRequest struct { // method. InputDocuments *GoogleCloudDocumentaiV1BatchDocumentsInputConfig `json:"inputDocuments,omitempty"` + // ProcessOptions: Inference-time options for the process API + ProcessOptions *GoogleCloudDocumentaiV1ProcessOptions `json:"processOptions,omitempty"` + // SkipHumanReview: Whether human review should be skipped for this // request. Default to `false`. SkipHumanReview bool `json:"skipHumanReview,omitempty"` @@ -5262,6 +5276,124 @@ func (s *GoogleCloudDocumentaiV1NormalizedVertex) UnmarshalJSON(data []byte) err return nil } +// GoogleCloudDocumentaiV1OcrConfig: Config for Document OCR. +type GoogleCloudDocumentaiV1OcrConfig struct { + // AdvancedOcrOptions: A list of advanced OCR options to further + // fine-tune OCR behavior. Current valid values are: - `legacy_layout`: + // a heuristics layout detection algorithm, which serves as an + // alternative to the current ML-based layout detection algorithm. + // Customers can choose the best suitable layout algorithm based on + // their situation. + AdvancedOcrOptions []string `json:"advancedOcrOptions,omitempty"` + + // ComputeStyleInfo: Turn on font id model and returns font style + // information. + ComputeStyleInfo bool `json:"computeStyleInfo,omitempty"` + + // EnableImageQualityScores: Enables intelligent document quality scores + // after OCR. Can help with diagnosing why OCR responses are of poor + // quality for a given input. Adds additional latency comparable to + // regular OCR to the process call. + EnableImageQualityScores bool `json:"enableImageQualityScores,omitempty"` + + // EnableNativePdfParsing: Enables special handling for PDFs with + // existing text information. Results in better text extraction quality + // in such PDF inputs. + EnableNativePdfParsing bool `json:"enableNativePdfParsing,omitempty"` + + // EnableSymbol: Includes symbol level OCR information if set to true. + EnableSymbol bool `json:"enableSymbol,omitempty"` + + // Hints: Hints for the OCR model. + Hints *GoogleCloudDocumentaiV1OcrConfigHints `json:"hints,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AdvancedOcrOptions") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AdvancedOcrOptions") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1OcrConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1OcrConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1OcrConfigHints: Hints for OCR Engine +type GoogleCloudDocumentaiV1OcrConfigHints struct { + // LanguageHints: List of BCP-47 language codes to use for OCR. In most + // cases, not specifying it yields the best results since it enables + // automatic language detection. For languages based on the Latin + // alphabet, setting hints is not needed. In rare cases, when the + // language of the text in the image is known, setting a hint will help + // get better results (although it will be a significant hindrance if + // the hint is wrong). + LanguageHints []string `json:"languageHints,omitempty"` + + // ForceSendFields is a list of field names (e.g. "LanguageHints") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "LanguageHints") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1OcrConfigHints) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1OcrConfigHints + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1ProcessOptions: Options for Process API +type GoogleCloudDocumentaiV1ProcessOptions struct { + // OcrConfig: Only applicable to `OCR_PROCESSOR`. Returns error if set + // on other processor types. + OcrConfig *GoogleCloudDocumentaiV1OcrConfig `json:"ocrConfig,omitempty"` + + // ForceSendFields is a list of field names (e.g. "OcrConfig") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "OcrConfig") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1ProcessOptions) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1ProcessOptions + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1ProcessRequest: Request message for the // ProcessDocument method. type GoogleCloudDocumentaiV1ProcessRequest struct { @@ -5271,9 +5403,15 @@ type GoogleCloudDocumentaiV1ProcessRequest struct { // `pages.{page_field_name}`. FieldMask string `json:"fieldMask,omitempty"` + // GcsDocument: A raw document on Google Cloud Storage. + GcsDocument *GoogleCloudDocumentaiV1GcsDocument `json:"gcsDocument,omitempty"` + // InlineDocument: An inline document proto. InlineDocument *GoogleCloudDocumentaiV1Document `json:"inlineDocument,omitempty"` + // ProcessOptions: Inference-time options for the process API + ProcessOptions *GoogleCloudDocumentaiV1ProcessOptions `json:"processOptions,omitempty"` + // RawDocument: A raw document content (bytes). RawDocument *GoogleCloudDocumentaiV1RawDocument `json:"rawDocument,omitempty"` @@ -10689,6 +10827,83 @@ func (s *GoogleCloudDocumentaiV1beta2Vertex) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata struct { + // CommonMetadata: The basic metadata of the long running operation. + CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + + // ErrorDocumentCount: Total number of documents that failed to be + // deleted in storage. + ErrorDocumentCount int64 `json:"errorDocumentCount,omitempty"` + + // IndividualBatchDeleteStatuses: The list of response details of each + // document. + IndividualBatchDeleteStatuses []*GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus `json:"individualBatchDeleteStatuses,omitempty"` + + // TotalDocumentCount: Total number of documents deleting from dataset. + TotalDocumentCount int64 `json:"totalDocumentCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CommonMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatc +// hDeleteStatus: The status of each individual document in the batch +// delete process. +type GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus struct { + // DocumentId: The document id of the document. + DocumentId *GoogleCloudDocumentaiV1beta3DocumentId `json:"documentId,omitempty"` + + // Status: The status of deleting the document in storage. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DocumentId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DocumentId") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: Response of +// the delete documents operation. +type GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse struct { +} + // GoogleCloudDocumentaiV1beta3BatchProcessMetadata: The long-running // operation metadata for BatchProcessDocuments. type GoogleCloudDocumentaiV1beta3BatchProcessMetadata struct { @@ -10848,6 +11063,142 @@ func (s *GoogleCloudDocumentaiV1beta3CommonOperationMetadata) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta3Dataset: A singleton resource under a +// Processor which configures a collection of documents. +type GoogleCloudDocumentaiV1beta3Dataset struct { + // DocumentWarehouseConfig: Optional. Document AI Warehouse-based + // dataset configuration. + DocumentWarehouseConfig *GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig `json:"documentWarehouseConfig,omitempty"` + + // GcsManagedConfig: Optional. User-managed Cloud Storage dataset + // configuration. Use this configuration if the dataset documents are + // stored under a user-managed Cloud Storage location. + GcsManagedConfig *GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig `json:"gcsManagedConfig,omitempty"` + + // Name: Dataset resource name. Format: + // `projects/{project}/locations/{location}/processors/{processor}/datase + // t` + Name string `json:"name,omitempty"` + + // SpannerIndexingConfig: Optional. A lightweight indexing source with + // low latency and high reliability, but lacking advanced features like + // CMEK and content-based search. + SpannerIndexingConfig *GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig `json:"spannerIndexingConfig,omitempty"` + + // State: Required. State of the dataset. Ignored when updating dataset. + // + // Possible values: + // "STATE_UNSPECIFIED" - Default unspecified enum, should not be used. + // "UNINITIALIZED" - Dataset has not been initialized. + // "INITIALIZING" - Dataset is being initialized. + // "INITIALIZED" - Dataset has been initialized. + State string `json:"state,omitempty"` + + // UnmanagedDatasetConfig: Optional. Unmanaged dataset configuration. + // Use this configuration if the dataset documents are managed by the + // document service internally (not user-managed). + UnmanagedDatasetConfig *GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig `json:"unmanagedDatasetConfig,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "DocumentWarehouseConfig") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DocumentWarehouseConfig") + // to include in API requests with the JSON null value. By default, + // fields with empty values are omitted from API requests. However, any + // field with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3Dataset) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3Dataset + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig: +// Configuration specific to the Document AI Warehouse-based +// implementation. +type GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig struct { + // Collection: Output only. The collection in Document AI Warehouse + // associated with the dataset. + Collection string `json:"collection,omitempty"` + + // Schema: Output only. The schema in Document AI Warehouse associated + // with the dataset. + Schema string `json:"schema,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Collection") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Collection") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig: Configuration +// specific to the Cloud Storage-based implementation. +type GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig struct { + // GcsPrefix: Required. The Cloud Storage URI (a directory) where the + // documents belonging to the dataset must be stored. + GcsPrefix *GoogleCloudDocumentaiV1beta3GcsPrefix `json:"gcsPrefix,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GcsPrefix") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "GcsPrefix") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig: +// Configuration specific to spanner-based indexing. +type GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig struct { +} + +// GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig: +// Configuration specific to an unmanaged dataset. +type GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig struct { +} + // GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: The long-running // operation metadata for the DeleteProcessor method. type GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata struct { @@ -10981,6 +11332,105 @@ func (s *GoogleCloudDocumentaiV1beta3DisableProcessorMetadata) MarshalJSON() ([] type GoogleCloudDocumentaiV1beta3DisableProcessorResponse struct { } +// GoogleCloudDocumentaiV1beta3DocumentId: Document Identifier. +type GoogleCloudDocumentaiV1beta3DocumentId struct { + // GcsManagedDocId: A document id within user-managed Cloud Storage. + GcsManagedDocId *GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId `json:"gcsManagedDocId,omitempty"` + + // RevisionRef: Points to a specific revision of the document if set. + RevisionRef *GoogleCloudDocumentaiV1beta3RevisionRef `json:"revisionRef,omitempty"` + + // UnmanagedDocId: A document id within unmanaged dataset. + UnmanagedDocId *GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId `json:"unmanagedDocId,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GcsManagedDocId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "GcsManagedDocId") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DocumentId) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DocumentId + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: +// Identifies a document uniquely within the scope of a dataset in the +// user-managed Cloud Storage option. +type GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId struct { + // CwDocId: Id of the document (indexed) managed by Content Warehouse. + CwDocId string `json:"cwDocId,omitempty"` + + // GcsUri: Required. The Cloud Storage URI where the actual document is + // stored. + GcsUri string `json:"gcsUri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CwDocId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CwDocId") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: Identifies +// a document uniquely within the scope of a dataset in unmanaged +// option. +type GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId struct { + // DocId: Required. The id of the document. + DocId string `json:"docId,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DocId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DocId") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: The long-running // operation metadata for the EnableProcessor method. type GoogleCloudDocumentaiV1beta3EnableProcessorMetadata struct { @@ -11076,6 +11526,35 @@ func (s *GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse) MarshalJS return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta3GcsPrefix: Specifies all documents on +// Cloud Storage with a common prefix. +type GoogleCloudDocumentaiV1beta3GcsPrefix struct { + // GcsUriPrefix: The URI prefix. + GcsUriPrefix string `json:"gcsUriPrefix,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GcsUriPrefix") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "GcsUriPrefix") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3GcsPrefix) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3GcsPrefix + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1beta3HumanReviewStatus: The status of human // review on a processed document. type GoogleCloudDocumentaiV1beta3HumanReviewStatus struct { @@ -11130,6 +11609,126 @@ func (s *GoogleCloudDocumentaiV1beta3HumanReviewStatus) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: Metadata of the +// import document operation. +type GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata struct { + // CommonMetadata: The basic metadata of the long running operation. + CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + + // ImportConfigValidationResults: Validation statuses of the batch + // documents import config. + ImportConfigValidationResults []*GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult `json:"importConfigValidationResults,omitempty"` + + // IndividualImportStatuses: The list of response details of each + // document. + IndividualImportStatuses []*GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus `json:"individualImportStatuses,omitempty"` + + // TotalDocumentCount: Total number of the documents that are qualified + // for importing. + TotalDocumentCount int64 `json:"totalDocumentCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CommonMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidat +// ionResult: The validation status of each import config. Status is set +// to errors if there is no documents to import in the import_config, or +// OK if the operation will try to proceed at least one document. +type GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult struct { + // InputGcsSource: The source Cloud Storage URI specified in the import + // config. + InputGcsSource string `json:"inputGcsSource,omitempty"` + + // Status: The validation status of import config. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InputGcsSource") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "InputGcsSource") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportSta +// tus: The status of each individual document in the import process. +type GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus struct { + // InputGcsSource: The source Cloud Storage URI of the document. + InputGcsSource string `json:"inputGcsSource,omitempty"` + + // OutputDocumentId: The document id of imported document if it was + // successful, otherwise empty. + OutputDocumentId *GoogleCloudDocumentaiV1beta3DocumentId `json:"outputDocumentId,omitempty"` + + // Status: The status of the importing of the document. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InputGcsSource") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "InputGcsSource") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: Response of the +// import document operation. +type GoogleCloudDocumentaiV1beta3ImportDocumentsResponse struct { +} + // GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: The // long-running operation metadata for the ImportProcessorVersion // method. @@ -11289,6 +11888,54 @@ func (s *GoogleCloudDocumentaiV1beta3ReviewDocumentResponse) MarshalJSON() ([]by return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta3RevisionRef: The revision reference +// specifies which revision on the document to read. +type GoogleCloudDocumentaiV1beta3RevisionRef struct { + // LatestProcessorVersion: Reads the revision generated by the processor + // version. The format takes the full resource name of processor + // version. + // `projects/{project}/locations/{location}/processors/{processor}/proces + // sorVersions/{processorVersion}` + LatestProcessorVersion string `json:"latestProcessorVersion,omitempty"` + + // RevisionCase: Reads the revision by the predefined case. + // + // Possible values: + // "REVISION_CASE_UNSPECIFIED" - Unspecified case, fallback to read + // the LATEST_HUMAN_REVIEW. + // "LATEST_HUMAN_REVIEW" - The latest revision made by a human. + // "LATEST_TIMESTAMP" - The latest revision based on timestamp. + // "BASE_OCR_REVISION" - The first (OCR) revision. + RevisionCase string `json:"revisionCase,omitempty"` + + // RevisionId: Reads the revision given by the id. + RevisionId string `json:"revisionId,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "LatestProcessorVersion") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "LatestProcessorVersion") + // to include in API requests with the JSON null value. By default, + // fields with empty values are omitted from API requests. However, any + // field with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3RevisionRef) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3RevisionRef + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: The // long-running operation metadata for the SetDefaultProcessorVersion // method. @@ -11473,6 +12120,34 @@ func (s *GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata) MarshalJS type GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse struct { } +type GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata struct { + // CommonMetadata: The basic metadata of the long running operation. + CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CommonMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudLocationListLocationsResponse: The response message for // Locations.ListLocations. type GoogleCloudLocationListLocationsResponse struct { diff --git a/documentai/v1beta2/documentai-api.json b/documentai/v1beta2/documentai-api.json index ee81dabc926..b7cab2ba3d6 100644 --- a/documentai/v1beta2/documentai-api.json +++ b/documentai/v1beta2/documentai-api.json @@ -292,7 +292,7 @@ } } }, - "revision": "20230609", + "revision": "20230706", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -395,6 +395,7 @@ "description": "The basic metadata of the long running operation." }, "destDatasetType": { + "deprecated": true, "description": "The destination dataset split type.", "enum": [ "DATASET_SPLIT_TYPE_UNSPECIFIED", @@ -604,6 +605,7 @@ "id": "GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId", "properties": { "cwDocId": { + "deprecated": true, "description": "Id of the document (indexed) managed by Content Warehouse.", "type": "string" }, @@ -817,6 +819,10 @@ "description": "The source Cloud Storage URI of the document.", "type": "string" }, + "outputDocumentId": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", + "description": "The document id of imported document if it was successful, otherwise empty." + }, "outputGcsDestination": { "description": "The output_gcs_destination of the processed document if it was successful, otherwise empty.", "type": "string" @@ -987,6 +993,14 @@ "description": "Response of the sample documents operation.", "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse", "properties": { + "sampleTestStatus": { + "$ref": "GoogleRpcStatus", + "description": "The status of sampling documents in test split." + }, + "sampleTrainingStatus": { + "$ref": "GoogleRpcStatus", + "description": "The status of sampling documents in training split." + }, "selectedDocuments": { "description": "The result of the sampling process.", "items": { @@ -1640,6 +1654,7 @@ "type": "array" }, "textStyles": { + "deprecated": true, "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyle" @@ -1837,6 +1852,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this page." }, "symbols": { @@ -1905,6 +1921,7 @@ "type": "number" }, "layoutId": { + "deprecated": true, "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", "type": "string" }, @@ -1957,6 +1974,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -2175,6 +2193,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -2224,6 +2243,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -2278,6 +2298,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this table." } }, @@ -2346,6 +2367,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." }, "styleInfo": { @@ -2476,6 +2498,7 @@ "id": "GoogleCloudDocumentaiV1beta1DocumentProvenance", "properties": { "id": { + "deprecated": true, "description": "The Id of this operation. Needs to be unique within the scope of the revision.", "format": "int32", "type": "integer" @@ -2488,6 +2511,7 @@ "type": "array" }, "revision": { + "deprecated": true, "description": "The index of the revision that produced this element.", "format": "int32", "type": "integer" @@ -2504,6 +2528,16 @@ "EVAL_APPROVED", "EVAL_SKIPPED" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + true, + true + ], "enumDescriptions": [ "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", "Add an element.", @@ -2524,6 +2558,7 @@ "id": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent", "properties": { "id": { + "deprecated": true, "description": "The id of the parent provenance.", "format": "int32", "type": "integer" @@ -2563,6 +2598,7 @@ "type": "string" }, "parent": { + "deprecated": true, "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", "items": { "format": "int32", @@ -2720,6 +2756,7 @@ "type": "string" }, "provenance": { + "deprecated": true, "description": "The history of this annotation.", "items": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance" @@ -3023,6 +3060,7 @@ "type": "array" }, "textStyles": { + "deprecated": true, "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyle" @@ -3240,6 +3278,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this page." }, "symbols": { @@ -3308,6 +3347,7 @@ "type": "number" }, "layoutId": { + "deprecated": true, "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", "type": "string" }, @@ -3360,6 +3400,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -3578,6 +3619,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -3627,6 +3669,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -3681,6 +3724,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this table." } }, @@ -3749,6 +3793,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." }, "styleInfo": { @@ -3879,6 +3924,7 @@ "id": "GoogleCloudDocumentaiV1beta2DocumentProvenance", "properties": { "id": { + "deprecated": true, "description": "The Id of this operation. Needs to be unique within the scope of the revision.", "format": "int32", "type": "integer" @@ -3891,6 +3937,7 @@ "type": "array" }, "revision": { + "deprecated": true, "description": "The index of the revision that produced this element.", "format": "int32", "type": "integer" @@ -3907,6 +3954,16 @@ "EVAL_APPROVED", "EVAL_SKIPPED" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + true, + true + ], "enumDescriptions": [ "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", "Add an element.", @@ -3927,6 +3984,7 @@ "id": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent", "properties": { "id": { + "deprecated": true, "description": "The id of the parent provenance.", "format": "int32", "type": "integer" @@ -3966,6 +4024,7 @@ "type": "string" }, "parent": { + "deprecated": true, "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", "items": { "format": "int32", @@ -4123,6 +4182,7 @@ "type": "string" }, "provenance": { + "deprecated": true, "description": "The history of this annotation.", "items": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance" @@ -4441,6 +4501,54 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata": { + "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + }, + "errorDocumentCount": { + "description": "Total number of documents that failed to be deleted in storage.", + "format": "int32", + "type": "integer" + }, + "individualBatchDeleteStatuses": { + "description": "The list of response details of each document.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus" + }, + "type": "array" + }, + "totalDocumentCount": { + "description": "Total number of documents deleting from dataset.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus": { + "description": "The status of each individual document in the batch delete process.", + "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus", + "properties": { + "documentId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentId", + "description": "The document id of the document." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of deleting the document in storage." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse": { + "description": "Response of the delete documents operation.", + "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3BatchProcessMetadata": { "description": "The long-running operation metadata for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadata", @@ -4496,6 +4604,7 @@ "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus", "properties": { "humanReviewOperation": { + "deprecated": true, "description": "The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by the ReviewDocument method.", "type": "string" }, @@ -4569,6 +4678,89 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3Dataset": { + "description": "A singleton resource under a Processor which configures a collection of documents.", + "id": "GoogleCloudDocumentaiV1beta3Dataset", + "properties": { + "documentWarehouseConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig", + "description": "Optional. Document AI Warehouse-based dataset configuration." + }, + "gcsManagedConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig", + "description": "Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location." + }, + "name": { + "description": "Dataset resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset`", + "type": "string" + }, + "spannerIndexingConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig", + "description": "Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search." + }, + "state": { + "description": "Required. State of the dataset. Ignored when updating dataset.", + "enum": [ + "STATE_UNSPECIFIED", + "UNINITIALIZED", + "INITIALIZING", + "INITIALIZED" + ], + "enumDescriptions": [ + "Default unspecified enum, should not be used.", + "Dataset has not been initialized.", + "Dataset is being initialized.", + "Dataset has been initialized." + ], + "type": "string" + }, + "unmanagedDatasetConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig", + "description": "Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed)." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig": { + "description": "Configuration specific to the Document AI Warehouse-based implementation.", + "id": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig", + "properties": { + "collection": { + "description": "Output only. The collection in Document AI Warehouse associated with the dataset.", + "readOnly": true, + "type": "string" + }, + "schema": { + "description": "Output only. The schema in Document AI Warehouse associated with the dataset.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig": { + "description": "Configuration specific to the Cloud Storage-based implementation.", + "id": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig", + "properties": { + "gcsPrefix": { + "$ref": "GoogleCloudDocumentaiV1beta3GcsPrefix", + "description": "Required. The Cloud Storage URI (a directory) where the documents belonging to the dataset must be stored." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig": { + "description": "Configuration specific to spanner-based indexing.", + "id": "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig": { + "description": "Configuration specific to an unmanaged dataset.", + "id": "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata": { "description": "The long-running operation metadata for the DeleteProcessor method.", "id": "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata", @@ -4625,6 +4817,52 @@ "properties": {}, "type": "object" }, + "GoogleCloudDocumentaiV1beta3DocumentId": { + "description": "Document Identifier.", + "id": "GoogleCloudDocumentaiV1beta3DocumentId", + "properties": { + "gcsManagedDocId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId", + "description": "A document id within user-managed Cloud Storage." + }, + "revisionRef": { + "$ref": "GoogleCloudDocumentaiV1beta3RevisionRef", + "description": "Points to a specific revision of the document if set." + }, + "unmanagedDocId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId", + "description": "A document id within unmanaged dataset." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId": { + "description": "Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.", + "id": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId", + "properties": { + "cwDocId": { + "deprecated": true, + "description": "Id of the document (indexed) managed by Content Warehouse.", + "type": "string" + }, + "gcsUri": { + "description": "Required. The Cloud Storage URI where the actual document is stored.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId": { + "description": "Identifies a document uniquely within the scope of a dataset in unmanaged option.", + "id": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId", + "properties": { + "docId": { + "description": "Required. The id of the document.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": { "description": "The long-running operation metadata for the EnableProcessor method.", "id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata", @@ -4664,6 +4902,17 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3GcsPrefix": { + "description": "Specifies all documents on Cloud Storage with a common prefix.", + "id": "GoogleCloudDocumentaiV1beta3GcsPrefix", + "properties": { + "gcsUriPrefix": { + "description": "The URI prefix.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3HumanReviewStatus": { "description": "The status of human review on a processed document.", "id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", @@ -4697,6 +4946,76 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata": { + "description": "Metadata of the import document operation.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + }, + "importConfigValidationResults": { + "description": "Validation statuses of the batch documents import config.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult" + }, + "type": "array" + }, + "individualImportStatuses": { + "description": "The list of response details of each document.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus" + }, + "type": "array" + }, + "totalDocumentCount": { + "description": "Total number of the documents that are qualified for importing.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult": { + "description": "The validation status of each import config. Status is set to errors if there is no documents to import in the import_config, or OK if the operation will try to proceed at least one document.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult", + "properties": { + "inputGcsSource": { + "description": "The source Cloud Storage URI specified in the import config.", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The validation status of import config." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus": { + "description": "The status of each individual document in the import process.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus", + "properties": { + "inputGcsSource": { + "description": "The source Cloud Storage URI of the document.", + "type": "string" + }, + "outputDocumentId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentId", + "description": "The document id of imported document if it was successful, otherwise empty." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of the importing of the document." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse": { + "description": "Response of the import document operation.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": { "description": "The long-running operation metadata for the ImportProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata", @@ -4797,6 +5116,37 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3RevisionRef": { + "description": "The revision reference specifies which revision on the document to read.", + "id": "GoogleCloudDocumentaiV1beta3RevisionRef", + "properties": { + "latestProcessorVersion": { + "description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", + "type": "string" + }, + "revisionCase": { + "description": "Reads the revision by the predefined case.", + "enum": [ + "REVISION_CASE_UNSPECIFIED", + "LATEST_HUMAN_REVIEW", + "LATEST_TIMESTAMP", + "BASE_OCR_REVISION" + ], + "enumDescriptions": [ + "Unspecified case, fallback to read the LATEST_HUMAN_REVIEW.", + "The latest revision made by a human.", + "The latest revision based on timestamp.", + "The first (OCR) revision." + ], + "type": "string" + }, + "revisionId": { + "description": "Reads the revision given by the id.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata": { "description": "The long-running operation metadata for the SetDefaultProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata", @@ -4892,6 +5242,16 @@ "properties": {}, "type": "object" }, + "GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata": { + "id": "GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + } + }, + "type": "object" + }, "GoogleLongrunningOperation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "GoogleLongrunningOperation", diff --git a/documentai/v1beta2/documentai-gen.go b/documentai/v1beta2/documentai-gen.go index c2a178ee7c9..8a783eb327f 100644 --- a/documentai/v1beta2/documentai-gen.go +++ b/documentai/v1beta2/documentai-gen.go @@ -1151,6 +1151,10 @@ type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus // InputGcsSource: The source Cloud Storage URI of the document. InputGcsSource string `json:"inputGcsSource,omitempty"` + // OutputDocumentId: The document id of imported document if it was + // successful, otherwise empty. + OutputDocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"outputDocumentId,omitempty"` + // OutputGcsDestination: The output_gcs_destination of the processed // document if it was successful, otherwise empty. OutputGcsDestination string `json:"outputGcsDestination,omitempty"` @@ -1462,18 +1466,25 @@ func (s *GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata) MarshalJSON() ([ // GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse: Response of // the sample documents operation. type GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse struct { + // SampleTestStatus: The status of sampling documents in test split. + SampleTestStatus *GoogleRpcStatus `json:"sampleTestStatus,omitempty"` + + // SampleTrainingStatus: The status of sampling documents in training + // split. + SampleTrainingStatus *GoogleRpcStatus `json:"sampleTrainingStatus,omitempty"` + // SelectedDocuments: The result of the sampling process. SelectedDocuments []*GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument `json:"selectedDocuments,omitempty"` - // ForceSendFields is a list of field names (e.g. "SelectedDocuments") - // to unconditionally include in API requests. By default, fields with + // ForceSendFields is a list of field names (e.g. "SampleTestStatus") to + // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "SelectedDocuments") to + // NullFields is a list of field names (e.g. "SampleTestStatus") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the @@ -7326,6 +7337,83 @@ func (s *GoogleCloudDocumentaiV1beta2Vertex) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata struct { + // CommonMetadata: The basic metadata of the long running operation. + CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + + // ErrorDocumentCount: Total number of documents that failed to be + // deleted in storage. + ErrorDocumentCount int64 `json:"errorDocumentCount,omitempty"` + + // IndividualBatchDeleteStatuses: The list of response details of each + // document. + IndividualBatchDeleteStatuses []*GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus `json:"individualBatchDeleteStatuses,omitempty"` + + // TotalDocumentCount: Total number of documents deleting from dataset. + TotalDocumentCount int64 `json:"totalDocumentCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CommonMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatc +// hDeleteStatus: The status of each individual document in the batch +// delete process. +type GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus struct { + // DocumentId: The document id of the document. + DocumentId *GoogleCloudDocumentaiV1beta3DocumentId `json:"documentId,omitempty"` + + // Status: The status of deleting the document in storage. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DocumentId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DocumentId") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: Response of +// the delete documents operation. +type GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse struct { +} + // GoogleCloudDocumentaiV1beta3BatchProcessMetadata: The long-running // operation metadata for BatchProcessDocuments. type GoogleCloudDocumentaiV1beta3BatchProcessMetadata struct { @@ -7485,6 +7573,142 @@ func (s *GoogleCloudDocumentaiV1beta3CommonOperationMetadata) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta3Dataset: A singleton resource under a +// Processor which configures a collection of documents. +type GoogleCloudDocumentaiV1beta3Dataset struct { + // DocumentWarehouseConfig: Optional. Document AI Warehouse-based + // dataset configuration. + DocumentWarehouseConfig *GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig `json:"documentWarehouseConfig,omitempty"` + + // GcsManagedConfig: Optional. User-managed Cloud Storage dataset + // configuration. Use this configuration if the dataset documents are + // stored under a user-managed Cloud Storage location. + GcsManagedConfig *GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig `json:"gcsManagedConfig,omitempty"` + + // Name: Dataset resource name. Format: + // `projects/{project}/locations/{location}/processors/{processor}/datase + // t` + Name string `json:"name,omitempty"` + + // SpannerIndexingConfig: Optional. A lightweight indexing source with + // low latency and high reliability, but lacking advanced features like + // CMEK and content-based search. + SpannerIndexingConfig *GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig `json:"spannerIndexingConfig,omitempty"` + + // State: Required. State of the dataset. Ignored when updating dataset. + // + // Possible values: + // "STATE_UNSPECIFIED" - Default unspecified enum, should not be used. + // "UNINITIALIZED" - Dataset has not been initialized. + // "INITIALIZING" - Dataset is being initialized. + // "INITIALIZED" - Dataset has been initialized. + State string `json:"state,omitempty"` + + // UnmanagedDatasetConfig: Optional. Unmanaged dataset configuration. + // Use this configuration if the dataset documents are managed by the + // document service internally (not user-managed). + UnmanagedDatasetConfig *GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig `json:"unmanagedDatasetConfig,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "DocumentWarehouseConfig") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DocumentWarehouseConfig") + // to include in API requests with the JSON null value. By default, + // fields with empty values are omitted from API requests. However, any + // field with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3Dataset) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3Dataset + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig: +// Configuration specific to the Document AI Warehouse-based +// implementation. +type GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig struct { + // Collection: Output only. The collection in Document AI Warehouse + // associated with the dataset. + Collection string `json:"collection,omitempty"` + + // Schema: Output only. The schema in Document AI Warehouse associated + // with the dataset. + Schema string `json:"schema,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Collection") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Collection") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig: Configuration +// specific to the Cloud Storage-based implementation. +type GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig struct { + // GcsPrefix: Required. The Cloud Storage URI (a directory) where the + // documents belonging to the dataset must be stored. + GcsPrefix *GoogleCloudDocumentaiV1beta3GcsPrefix `json:"gcsPrefix,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GcsPrefix") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "GcsPrefix") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig: +// Configuration specific to spanner-based indexing. +type GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig struct { +} + +// GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig: +// Configuration specific to an unmanaged dataset. +type GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig struct { +} + // GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: The long-running // operation metadata for the DeleteProcessor method. type GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata struct { @@ -7618,6 +7842,105 @@ func (s *GoogleCloudDocumentaiV1beta3DisableProcessorMetadata) MarshalJSON() ([] type GoogleCloudDocumentaiV1beta3DisableProcessorResponse struct { } +// GoogleCloudDocumentaiV1beta3DocumentId: Document Identifier. +type GoogleCloudDocumentaiV1beta3DocumentId struct { + // GcsManagedDocId: A document id within user-managed Cloud Storage. + GcsManagedDocId *GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId `json:"gcsManagedDocId,omitempty"` + + // RevisionRef: Points to a specific revision of the document if set. + RevisionRef *GoogleCloudDocumentaiV1beta3RevisionRef `json:"revisionRef,omitempty"` + + // UnmanagedDocId: A document id within unmanaged dataset. + UnmanagedDocId *GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId `json:"unmanagedDocId,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GcsManagedDocId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "GcsManagedDocId") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DocumentId) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DocumentId + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: +// Identifies a document uniquely within the scope of a dataset in the +// user-managed Cloud Storage option. +type GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId struct { + // CwDocId: Id of the document (indexed) managed by Content Warehouse. + CwDocId string `json:"cwDocId,omitempty"` + + // GcsUri: Required. The Cloud Storage URI where the actual document is + // stored. + GcsUri string `json:"gcsUri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CwDocId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CwDocId") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: Identifies +// a document uniquely within the scope of a dataset in unmanaged +// option. +type GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId struct { + // DocId: Required. The id of the document. + DocId string `json:"docId,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DocId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DocId") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: The long-running // operation metadata for the EnableProcessor method. type GoogleCloudDocumentaiV1beta3EnableProcessorMetadata struct { @@ -7713,6 +8036,35 @@ func (s *GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse) MarshalJS return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta3GcsPrefix: Specifies all documents on +// Cloud Storage with a common prefix. +type GoogleCloudDocumentaiV1beta3GcsPrefix struct { + // GcsUriPrefix: The URI prefix. + GcsUriPrefix string `json:"gcsUriPrefix,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GcsUriPrefix") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "GcsUriPrefix") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3GcsPrefix) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3GcsPrefix + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1beta3HumanReviewStatus: The status of human // review on a processed document. type GoogleCloudDocumentaiV1beta3HumanReviewStatus struct { @@ -7767,6 +8119,126 @@ func (s *GoogleCloudDocumentaiV1beta3HumanReviewStatus) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: Metadata of the +// import document operation. +type GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata struct { + // CommonMetadata: The basic metadata of the long running operation. + CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + + // ImportConfigValidationResults: Validation statuses of the batch + // documents import config. + ImportConfigValidationResults []*GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult `json:"importConfigValidationResults,omitempty"` + + // IndividualImportStatuses: The list of response details of each + // document. + IndividualImportStatuses []*GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus `json:"individualImportStatuses,omitempty"` + + // TotalDocumentCount: Total number of the documents that are qualified + // for importing. + TotalDocumentCount int64 `json:"totalDocumentCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CommonMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidat +// ionResult: The validation status of each import config. Status is set +// to errors if there is no documents to import in the import_config, or +// OK if the operation will try to proceed at least one document. +type GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult struct { + // InputGcsSource: The source Cloud Storage URI specified in the import + // config. + InputGcsSource string `json:"inputGcsSource,omitempty"` + + // Status: The validation status of import config. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InputGcsSource") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "InputGcsSource") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportSta +// tus: The status of each individual document in the import process. +type GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus struct { + // InputGcsSource: The source Cloud Storage URI of the document. + InputGcsSource string `json:"inputGcsSource,omitempty"` + + // OutputDocumentId: The document id of imported document if it was + // successful, otherwise empty. + OutputDocumentId *GoogleCloudDocumentaiV1beta3DocumentId `json:"outputDocumentId,omitempty"` + + // Status: The status of the importing of the document. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InputGcsSource") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "InputGcsSource") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: Response of the +// import document operation. +type GoogleCloudDocumentaiV1beta3ImportDocumentsResponse struct { +} + // GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: The // long-running operation metadata for the ImportProcessorVersion // method. @@ -7926,6 +8398,54 @@ func (s *GoogleCloudDocumentaiV1beta3ReviewDocumentResponse) MarshalJSON() ([]by return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta3RevisionRef: The revision reference +// specifies which revision on the document to read. +type GoogleCloudDocumentaiV1beta3RevisionRef struct { + // LatestProcessorVersion: Reads the revision generated by the processor + // version. The format takes the full resource name of processor + // version. + // `projects/{project}/locations/{location}/processors/{processor}/proces + // sorVersions/{processorVersion}` + LatestProcessorVersion string `json:"latestProcessorVersion,omitempty"` + + // RevisionCase: Reads the revision by the predefined case. + // + // Possible values: + // "REVISION_CASE_UNSPECIFIED" - Unspecified case, fallback to read + // the LATEST_HUMAN_REVIEW. + // "LATEST_HUMAN_REVIEW" - The latest revision made by a human. + // "LATEST_TIMESTAMP" - The latest revision based on timestamp. + // "BASE_OCR_REVISION" - The first (OCR) revision. + RevisionCase string `json:"revisionCase,omitempty"` + + // RevisionId: Reads the revision given by the id. + RevisionId string `json:"revisionId,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "LatestProcessorVersion") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "LatestProcessorVersion") + // to include in API requests with the JSON null value. By default, + // fields with empty values are omitted from API requests. However, any + // field with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3RevisionRef) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3RevisionRef + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: The // long-running operation metadata for the SetDefaultProcessorVersion // method. @@ -8110,6 +8630,34 @@ func (s *GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata) MarshalJS type GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse struct { } +type GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata struct { + // CommonMetadata: The basic metadata of the long running operation. + CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CommonMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleLongrunningOperation: This resource represents a long-running // operation that is the result of a network API call. type GoogleLongrunningOperation struct { diff --git a/documentai/v1beta3/documentai-api.json b/documentai/v1beta3/documentai-api.json index 53eb55eac28..0e85008a7cf 100644 --- a/documentai/v1beta3/documentai-api.json +++ b/documentai/v1beta3/documentai-api.json @@ -656,6 +656,34 @@ "resources": { "dataset": { "methods": { + "batchDeleteDocuments": { + "description": "Deletes a set of documents.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/dataset:batchDeleteDocuments", + "httpMethod": "POST", + "id": "documentai.projects.locations.processors.dataset.batchDeleteDocuments", + "parameterOrder": [ + "dataset" + ], + "parameters": { + "dataset": { + "description": "Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/dataset$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+dataset}:batchDeleteDocuments", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getDatasetSchema": { "description": "Gets the `DatasetSchema` of a `Dataset`.", "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/dataset/datasetSchema", @@ -686,6 +714,120 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getDocument": { + "description": "Returns relevant fields present in the requested document.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/dataset:getDocument", + "httpMethod": "GET", + "id": "documentai.projects.locations.processors.dataset.getDocument", + "parameterOrder": [ + "dataset" + ], + "parameters": { + "dataset": { + "description": "Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/dataset", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/dataset$", + "required": true, + "type": "string" + }, + "documentId.gcsManagedDocId.cwDocId": { + "deprecated": true, + "description": "Id of the document (indexed) managed by Content Warehouse.", + "location": "query", + "type": "string" + }, + "documentId.gcsManagedDocId.gcsUri": { + "description": "Required. The Cloud Storage URI where the actual document is stored.", + "location": "query", + "type": "string" + }, + "documentId.revisionRef.latestProcessorVersion": { + "description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", + "location": "query", + "type": "string" + }, + "documentId.revisionRef.revisionCase": { + "description": "Reads the revision by the predefined case.", + "enum": [ + "REVISION_CASE_UNSPECIFIED", + "LATEST_HUMAN_REVIEW", + "LATEST_TIMESTAMP", + "BASE_OCR_REVISION" + ], + "enumDescriptions": [ + "Unspecified case, fallback to read the LATEST_HUMAN_REVIEW.", + "The latest revision made by a human.", + "The latest revision based on timestamp.", + "The first (OCR) revision." + ], + "location": "query", + "type": "string" + }, + "documentId.revisionRef.revisionId": { + "description": "Reads the revision given by the id.", + "location": "query", + "type": "string" + }, + "documentId.unmanagedDocId.docId": { + "description": "Required. The id of the document.", + "location": "query", + "type": "string" + }, + "pageRange.end": { + "description": "Last page number (one-based index) to be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageRange.start": { + "description": "First page number (one-based index) to be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "readMask": { + "description": "If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta3/{+dataset}:getDocument", + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3GetDocumentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "importDocuments": { + "description": "Import documents into a dataset.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/dataset:importDocuments", + "httpMethod": "POST", + "id": "documentai.projects.locations.processors.dataset.importDocuments", + "parameterOrder": [ + "dataset" + ], + "parameters": { + "dataset": { + "description": "Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/dataset$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+dataset}:importDocuments", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "updateDatasetSchema": { "description": "Updates a `DatasetSchema`.", "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/dataset/datasetSchema", @@ -1114,7 +1256,7 @@ } } }, - "revision": "20230619", + "revision": "20230706", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -1217,6 +1359,7 @@ "description": "The basic metadata of the long running operation." }, "destDatasetType": { + "deprecated": true, "description": "The destination dataset split type.", "enum": [ "DATASET_SPLIT_TYPE_UNSPECIFIED", @@ -1426,6 +1569,7 @@ "id": "GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId", "properties": { "cwDocId": { + "deprecated": true, "description": "Id of the document (indexed) managed by Content Warehouse.", "type": "string" }, @@ -1639,6 +1783,10 @@ "description": "The source Cloud Storage URI of the document.", "type": "string" }, + "outputDocumentId": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", + "description": "The document id of imported document if it was successful, otherwise empty." + }, "outputGcsDestination": { "description": "The output_gcs_destination of the processed document if it was successful, otherwise empty.", "type": "string" @@ -1809,6 +1957,14 @@ "description": "Response of the sample documents operation.", "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse", "properties": { + "sampleTestStatus": { + "$ref": "GoogleRpcStatus", + "description": "The status of sampling documents in test split." + }, + "sampleTrainingStatus": { + "$ref": "GoogleRpcStatus", + "description": "The status of sampling documents in training split." + }, "selectedDocuments": { "description": "The result of the sampling process.", "items": { @@ -2462,6 +2618,7 @@ "type": "array" }, "textStyles": { + "deprecated": true, "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyle" @@ -2659,6 +2816,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this page." }, "symbols": { @@ -2727,6 +2885,7 @@ "type": "number" }, "layoutId": { + "deprecated": true, "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", "type": "string" }, @@ -2779,6 +2938,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -2997,6 +3157,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -3046,6 +3207,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -3100,6 +3262,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this table." } }, @@ -3168,6 +3331,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." }, "styleInfo": { @@ -3298,6 +3462,7 @@ "id": "GoogleCloudDocumentaiV1beta1DocumentProvenance", "properties": { "id": { + "deprecated": true, "description": "The Id of this operation. Needs to be unique within the scope of the revision.", "format": "int32", "type": "integer" @@ -3310,6 +3475,7 @@ "type": "array" }, "revision": { + "deprecated": true, "description": "The index of the revision that produced this element.", "format": "int32", "type": "integer" @@ -3326,6 +3492,16 @@ "EVAL_APPROVED", "EVAL_SKIPPED" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + true, + true + ], "enumDescriptions": [ "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", "Add an element.", @@ -3346,6 +3522,7 @@ "id": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent", "properties": { "id": { + "deprecated": true, "description": "The id of the parent provenance.", "format": "int32", "type": "integer" @@ -3385,6 +3562,7 @@ "type": "string" }, "parent": { + "deprecated": true, "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", "items": { "format": "int32", @@ -3542,6 +3720,7 @@ "type": "string" }, "provenance": { + "deprecated": true, "description": "The history of this annotation.", "items": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance" @@ -3820,6 +3999,7 @@ "type": "array" }, "textStyles": { + "deprecated": true, "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyle" @@ -4037,6 +4217,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this page." }, "symbols": { @@ -4105,6 +4286,7 @@ "type": "number" }, "layoutId": { + "deprecated": true, "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", "type": "string" }, @@ -4157,6 +4339,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -4375,6 +4558,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -4424,6 +4608,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -4478,6 +4663,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this table." } }, @@ -4546,6 +4732,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." }, "styleInfo": { @@ -4676,6 +4863,7 @@ "id": "GoogleCloudDocumentaiV1beta2DocumentProvenance", "properties": { "id": { + "deprecated": true, "description": "The Id of this operation. Needs to be unique within the scope of the revision.", "format": "int32", "type": "integer" @@ -4688,6 +4876,7 @@ "type": "array" }, "revision": { + "deprecated": true, "description": "The index of the revision that produced this element.", "format": "int32", "type": "integer" @@ -4704,6 +4893,16 @@ "EVAL_APPROVED", "EVAL_SKIPPED" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + true, + true + ], "enumDescriptions": [ "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", "Add an element.", @@ -4724,6 +4923,7 @@ "id": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent", "properties": { "id": { + "deprecated": true, "description": "The id of the parent provenance.", "format": "int32", "type": "integer" @@ -4763,6 +4963,7 @@ "type": "string" }, "parent": { + "deprecated": true, "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", "items": { "format": "int32", @@ -4920,6 +5121,7 @@ "type": "string" }, "provenance": { + "deprecated": true, "description": "The history of this annotation.", "items": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance" @@ -5100,6 +5302,93 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3BatchDatasetDocuments": { + "description": "Dataset documents that the batch operation will be applied to.", + "id": "GoogleCloudDocumentaiV1beta3BatchDatasetDocuments", + "properties": { + "filter": { + "description": "A filter matching the documents. Follows the same format and restriction as [google.cloud.documentai.master.ListDocumentsRequest.filter].", + "type": "string" + }, + "individualDocumentIds": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds", + "description": "Document identifiers." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds": { + "description": "List of individual DocumentIds.", + "id": "GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds", + "properties": { + "documentIds": { + "description": "Required. List of Document IDs indicating where the actual documents are stored.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentId" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata": { + "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + }, + "errorDocumentCount": { + "description": "Total number of documents that failed to be deleted in storage.", + "format": "int32", + "type": "integer" + }, + "individualBatchDeleteStatuses": { + "description": "The list of response details of each document.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus" + }, + "type": "array" + }, + "totalDocumentCount": { + "description": "Total number of documents deleting from dataset.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus": { + "description": "The status of each individual document in the batch delete process.", + "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus", + "properties": { + "documentId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentId", + "description": "The document id of the document." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of deleting the document in storage." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest": { + "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest", + "properties": { + "datasetDocuments": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchDatasetDocuments", + "description": "Required. Dataset documents input. If given `filter`, all documents satisfying the filter will be deleted. If given documentIds, a maximum of 50 documents can be deleted in a batch. The request will be rejected if more than 50 document_ids are provided." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse": { + "description": "Response of the delete documents operation.", + "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig": { "description": "The common config to specify a set of documents used as input.", "id": "GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig", @@ -5170,6 +5459,7 @@ "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus", "properties": { "humanReviewOperation": { + "deprecated": true, "description": "The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by the ReviewDocument method.", "type": "string" }, @@ -5201,6 +5491,7 @@ "description": "The output configuration for the BatchProcessDocuments method." }, "inputConfigs": { + "deprecated": true, "description": "The input config for each single document in the batch process.", "items": { "$ref": "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig" @@ -5213,6 +5504,7 @@ }, "outputConfig": { "$ref": "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig", + "deprecated": true, "description": "The overall output config for batch process." }, "processOptions": { @@ -5227,6 +5519,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig": { + "deprecated": true, "description": "The message for input config in batch process.", "id": "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig", "properties": { @@ -5242,6 +5535,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig": { + "deprecated": true, "description": "The output configuration in the BatchProcessDocuments method.", "id": "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig", "properties": { @@ -5551,6 +5845,7 @@ "type": "array" }, "textStyles": { + "deprecated": true, "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentStyle" @@ -5679,6 +5974,52 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3DocumentId": { + "description": "Document Identifier.", + "id": "GoogleCloudDocumentaiV1beta3DocumentId", + "properties": { + "gcsManagedDocId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId", + "description": "A document id within user-managed Cloud Storage." + }, + "revisionRef": { + "$ref": "GoogleCloudDocumentaiV1beta3RevisionRef", + "description": "Points to a specific revision of the document if set." + }, + "unmanagedDocId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId", + "description": "A document id within unmanaged dataset." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId": { + "description": "Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.", + "id": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId", + "properties": { + "cwDocId": { + "deprecated": true, + "description": "Id of the document (indexed) managed by Content Warehouse.", + "type": "string" + }, + "gcsUri": { + "description": "Required. The Cloud Storage URI where the actual document is stored.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId": { + "description": "Identifies a document uniquely within the scope of a dataset in unmanaged option.", + "id": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId", + "properties": { + "docId": { + "description": "Required. The id of the document.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3DocumentOutputConfig": { "description": "Config that controls the output of documents. All documents will be written as a JSON file.", "id": "GoogleCloudDocumentaiV1beta3DocumentOutputConfig", @@ -5796,6 +6137,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance", + "deprecated": true, "description": "The history of this page." }, "symbols": { @@ -5864,6 +6206,7 @@ "type": "number" }, "layoutId": { + "deprecated": true, "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", "type": "string" }, @@ -5916,6 +6259,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -6134,6 +6478,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -6183,6 +6528,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." } }, @@ -6237,6 +6583,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance", + "deprecated": true, "description": "The history of this table." } }, @@ -6305,6 +6652,7 @@ }, "provenance": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance", + "deprecated": true, "description": "The history of this annotation." }, "styleInfo": { @@ -6435,6 +6783,7 @@ "id": "GoogleCloudDocumentaiV1beta3DocumentProvenance", "properties": { "id": { + "deprecated": true, "description": "The Id of this operation. Needs to be unique within the scope of the revision.", "format": "int32", "type": "integer" @@ -6447,6 +6796,7 @@ "type": "array" }, "revision": { + "deprecated": true, "description": "The index of the revision that produced this element.", "format": "int32", "type": "integer" @@ -6463,6 +6813,16 @@ "EVAL_APPROVED", "EVAL_SKIPPED" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + true, + true + ], "enumDescriptions": [ "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", "Add an element.", @@ -6483,6 +6843,7 @@ "id": "GoogleCloudDocumentaiV1beta3DocumentProvenanceParent", "properties": { "id": { + "deprecated": true, "description": "The id of the parent provenance.", "format": "int32", "type": "integer" @@ -6522,6 +6883,7 @@ "type": "string" }, "parent": { + "deprecated": true, "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", "items": { "format": "int32", @@ -6816,6 +7178,7 @@ "type": "string" }, "provenance": { + "deprecated": true, "description": "The history of this annotation.", "items": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance" @@ -7170,6 +7533,15 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3GetDocumentResponse": { + "id": "GoogleCloudDocumentaiV1beta3GetDocumentResponse", + "properties": { + "document": { + "$ref": "GoogleCloudDocumentaiV1beta3Document" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3HumanReviewStatus": { "description": "The status of human review on a processed document.", "id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", @@ -7203,6 +7575,132 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata": { + "description": "Metadata of the import document operation.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + }, + "importConfigValidationResults": { + "description": "Validation statuses of the batch documents import config.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult" + }, + "type": "array" + }, + "individualImportStatuses": { + "description": "The list of response details of each document.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus" + }, + "type": "array" + }, + "totalDocumentCount": { + "description": "Total number of the documents that are qualified for importing.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult": { + "description": "The validation status of each import config. Status is set to errors if there is no documents to import in the import_config, or OK if the operation will try to proceed at least one document.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult", + "properties": { + "inputGcsSource": { + "description": "The source Cloud Storage URI specified in the import config.", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The validation status of import config." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus": { + "description": "The status of each individual document in the import process.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus", + "properties": { + "inputGcsSource": { + "description": "The source Cloud Storage URI of the document.", + "type": "string" + }, + "outputDocumentId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentId", + "description": "The document id of imported document if it was successful, otherwise empty." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of the importing of the document." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsRequest": { + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsRequest", + "properties": { + "batchDocumentsImportConfigs": { + "description": "Required. The Cloud Storage uri containing raw documents that must be imported.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig": { + "description": "Config for importing documents. Each batch can have its own dataset split type.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig", + "properties": { + "autoSplitConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig", + "description": "If set, documents will be automatically split into training and test split category with the specified ratio." + }, + "batchInputConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig", + "description": "The common config to specify a set of documents used as input." + }, + "datasetSplit": { + "description": "Target dataset split where the documents must be stored.", + "enum": [ + "DATASET_SPLIT_TYPE_UNSPECIFIED", + "DATASET_SPLIT_TRAIN", + "DATASET_SPLIT_TEST", + "DATASET_SPLIT_UNASSIGNED" + ], + "enumDescriptions": [ + "Default value if the enum is not set. go/protodosdonts#do-include-an-unspecified-value-in-an-enum", + "Identifies the train documents.", + "Identifies the test documents.", + "Identifies the unassigned documents." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig": { + "description": "The config for auto-split.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig", + "properties": { + "trainingSplitRatio": { + "description": "Ratio of training dataset split.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse": { + "description": "Response of the import document operation.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": { "description": "The long-running operation metadata for the ImportProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata", @@ -7390,6 +7888,7 @@ "properties": { "document": { "$ref": "GoogleCloudDocumentaiV1beta3Document", + "deprecated": true, "description": "The document payload, the content and mime_type fields must be set." }, "fieldMask": { @@ -7397,6 +7896,10 @@ "format": "google-fieldmask", "type": "string" }, + "gcsDocument": { + "$ref": "GoogleCloudDocumentaiV1beta3GcsDocument", + "description": "A raw document on Google Cloud Storage." + }, "inlineDocument": { "$ref": "GoogleCloudDocumentaiV1beta3Document", "description": "An inline document proto." @@ -7425,6 +7928,7 @@ "description": "The document payload, will populate fields based on the processor's behavior." }, "humanReviewOperation": { + "deprecated": true, "description": "The name of the operation triggered by the processed document. If the human review process isn't triggered, this field is empty. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", "type": "string" }, @@ -7738,6 +8242,7 @@ "properties": { "document": { "$ref": "GoogleCloudDocumentaiV1beta3Document", + "deprecated": true, "description": "The document that needs human review." }, "documentSchema": { @@ -7796,6 +8301,37 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3RevisionRef": { + "description": "The revision reference specifies which revision on the document to read.", + "id": "GoogleCloudDocumentaiV1beta3RevisionRef", + "properties": { + "latestProcessorVersion": { + "description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", + "type": "string" + }, + "revisionCase": { + "description": "Reads the revision by the predefined case.", + "enum": [ + "REVISION_CASE_UNSPECIFIED", + "LATEST_HUMAN_REVIEW", + "LATEST_TIMESTAMP", + "BASE_OCR_REVISION" + ], + "enumDescriptions": [ + "Unspecified case, fallback to read the LATEST_HUMAN_REVIEW.", + "The latest revision made by a human.", + "The latest revision based on timestamp.", + "The first (OCR) revision." + ], + "type": "string" + }, + "revisionId": { + "description": "Reads the revision given by the id.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata": { "description": "The long-running operation metadata for the SetDefaultProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata", @@ -7971,6 +8507,16 @@ "properties": {}, "type": "object" }, + "GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata": { + "id": "GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3Vertex": { "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudDocumentaiV1beta3Vertex", diff --git a/documentai/v1beta3/documentai-gen.go b/documentai/v1beta3/documentai-gen.go index ab73d1e7f41..3050f1d4e27 100644 --- a/documentai/v1beta3/documentai-gen.go +++ b/documentai/v1beta3/documentai-gen.go @@ -1187,6 +1187,10 @@ type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus // InputGcsSource: The source Cloud Storage URI of the document. InputGcsSource string `json:"inputGcsSource,omitempty"` + // OutputDocumentId: The document id of imported document if it was + // successful, otherwise empty. + OutputDocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"outputDocumentId,omitempty"` + // OutputGcsDestination: The output_gcs_destination of the processed // document if it was successful, otherwise empty. OutputGcsDestination string `json:"outputGcsDestination,omitempty"` @@ -1498,18 +1502,25 @@ func (s *GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata) MarshalJSON() ([ // GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse: Response of // the sample documents operation. type GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse struct { + // SampleTestStatus: The status of sampling documents in test split. + SampleTestStatus *GoogleRpcStatus `json:"sampleTestStatus,omitempty"` + + // SampleTrainingStatus: The status of sampling documents in training + // split. + SampleTrainingStatus *GoogleRpcStatus `json:"sampleTrainingStatus,omitempty"` + // SelectedDocuments: The result of the sampling process. SelectedDocuments []*GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument `json:"selectedDocuments,omitempty"` - // ForceSendFields is a list of field names (e.g. "SelectedDocuments") - // to unconditionally include in API requests. By default, fields with + // ForceSendFields is a list of field names (e.g. "SampleTestStatus") to + // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "SelectedDocuments") to + // NullFields is a list of field names (e.g. "SampleTestStatus") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the @@ -7059,6 +7070,179 @@ func (s *GoogleCloudDocumentaiV1beta3Barcode) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta3BatchDatasetDocuments: Dataset documents +// that the batch operation will be applied to. +type GoogleCloudDocumentaiV1beta3BatchDatasetDocuments struct { + // Filter: A filter matching the documents. Follows the same format and + // restriction as + // [google.cloud.documentai.master.ListDocumentsRequest.filter]. + Filter string `json:"filter,omitempty"` + + // IndividualDocumentIds: Document identifiers. + IndividualDocumentIds *GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds `json:"individualDocumentIds,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Filter") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Filter") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3BatchDatasetDocuments) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3BatchDatasetDocuments + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds +// : List of individual DocumentIds. +type GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds struct { + // DocumentIds: Required. List of Document IDs indicating where the + // actual documents are stored. + DocumentIds []*GoogleCloudDocumentaiV1beta3DocumentId `json:"documentIds,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DocumentIds") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DocumentIds") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata struct { + // CommonMetadata: The basic metadata of the long running operation. + CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + + // ErrorDocumentCount: Total number of documents that failed to be + // deleted in storage. + ErrorDocumentCount int64 `json:"errorDocumentCount,omitempty"` + + // IndividualBatchDeleteStatuses: The list of response details of each + // document. + IndividualBatchDeleteStatuses []*GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus `json:"individualBatchDeleteStatuses,omitempty"` + + // TotalDocumentCount: Total number of documents deleting from dataset. + TotalDocumentCount int64 `json:"totalDocumentCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CommonMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatc +// hDeleteStatus: The status of each individual document in the batch +// delete process. +type GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus struct { + // DocumentId: The document id of the document. + DocumentId *GoogleCloudDocumentaiV1beta3DocumentId `json:"documentId,omitempty"` + + // Status: The status of deleting the document in storage. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DocumentId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DocumentId") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest struct { + // DatasetDocuments: Required. Dataset documents input. If given + // `filter`, all documents satisfying the filter will be deleted. If + // given documentIds, a maximum of 50 documents can be deleted in a + // batch. The request will be rejected if more than 50 document_ids are + // provided. + DatasetDocuments *GoogleCloudDocumentaiV1beta3BatchDatasetDocuments `json:"datasetDocuments,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DatasetDocuments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DatasetDocuments") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: Response of +// the delete documents operation. +type GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse struct { +} + // GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig: The common // config to specify a set of documents used as input. type GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig struct { @@ -7995,6 +8179,105 @@ func (s *GoogleCloudDocumentaiV1beta3DocumentEntityRelation) MarshalJSON() ([]by return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta3DocumentId: Document Identifier. +type GoogleCloudDocumentaiV1beta3DocumentId struct { + // GcsManagedDocId: A document id within user-managed Cloud Storage. + GcsManagedDocId *GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId `json:"gcsManagedDocId,omitempty"` + + // RevisionRef: Points to a specific revision of the document if set. + RevisionRef *GoogleCloudDocumentaiV1beta3RevisionRef `json:"revisionRef,omitempty"` + + // UnmanagedDocId: A document id within unmanaged dataset. + UnmanagedDocId *GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId `json:"unmanagedDocId,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GcsManagedDocId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "GcsManagedDocId") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DocumentId) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DocumentId + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: +// Identifies a document uniquely within the scope of a dataset in the +// user-managed Cloud Storage option. +type GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId struct { + // CwDocId: Id of the document (indexed) managed by Content Warehouse. + CwDocId string `json:"cwDocId,omitempty"` + + // GcsUri: Required. The Cloud Storage URI where the actual document is + // stored. + GcsUri string `json:"gcsUri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CwDocId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CwDocId") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: Identifies +// a document uniquely within the scope of a dataset in unmanaged +// option. +type GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId struct { + // DocId: Required. The id of the document. + DocId string `json:"docId,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DocId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DocId") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1beta3DocumentOutputConfig: Config that // controls the output of documents. All documents will be written as a // JSON file. @@ -10486,6 +10769,36 @@ func (s *GoogleCloudDocumentaiV1beta3GcsPrefix) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type GoogleCloudDocumentaiV1beta3GetDocumentResponse struct { + Document *GoogleCloudDocumentaiV1beta3Document `json:"document,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Document") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Document") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3GetDocumentResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3GetDocumentResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1beta3HumanReviewStatus: The status of human // review on a processed document. type GoogleCloudDocumentaiV1beta3HumanReviewStatus struct { @@ -10540,11 +10853,252 @@ func (s *GoogleCloudDocumentaiV1beta3HumanReviewStatus) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: The -// long-running operation metadata for the ImportProcessorVersion -// method. -type GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata for the long-running operation. +// GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: Metadata of the +// import document operation. +type GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata struct { + // CommonMetadata: The basic metadata of the long running operation. + CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + + // ImportConfigValidationResults: Validation statuses of the batch + // documents import config. + ImportConfigValidationResults []*GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult `json:"importConfigValidationResults,omitempty"` + + // IndividualImportStatuses: The list of response details of each + // document. + IndividualImportStatuses []*GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus `json:"individualImportStatuses,omitempty"` + + // TotalDocumentCount: Total number of the documents that are qualified + // for importing. + TotalDocumentCount int64 `json:"totalDocumentCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CommonMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidat +// ionResult: The validation status of each import config. Status is set +// to errors if there is no documents to import in the import_config, or +// OK if the operation will try to proceed at least one document. +type GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult struct { + // InputGcsSource: The source Cloud Storage URI specified in the import + // config. + InputGcsSource string `json:"inputGcsSource,omitempty"` + + // Status: The validation status of import config. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InputGcsSource") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "InputGcsSource") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportSta +// tus: The status of each individual document in the import process. +type GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus struct { + // InputGcsSource: The source Cloud Storage URI of the document. + InputGcsSource string `json:"inputGcsSource,omitempty"` + + // OutputDocumentId: The document id of imported document if it was + // successful, otherwise empty. + OutputDocumentId *GoogleCloudDocumentaiV1beta3DocumentId `json:"outputDocumentId,omitempty"` + + // Status: The status of the importing of the document. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InputGcsSource") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "InputGcsSource") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type GoogleCloudDocumentaiV1beta3ImportDocumentsRequest struct { + // BatchDocumentsImportConfigs: Required. The Cloud Storage uri + // containing raw documents that must be imported. + BatchDocumentsImportConfigs []*GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig `json:"batchDocumentsImportConfigs,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "BatchDocumentsImportConfigs") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "BatchDocumentsImportConfigs") to include in API requests with the + // JSON null value. By default, fields with empty values are omitted + // from API requests. However, any field with an empty value appearing + // in NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3ImportDocumentsRequest) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3ImportDocumentsRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImport +// Config: Config for importing documents. Each batch can have its own +// dataset split type. +type GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig struct { + // AutoSplitConfig: If set, documents will be automatically split into + // training and test split category with the specified ratio. + AutoSplitConfig *GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig `json:"autoSplitConfig,omitempty"` + + // BatchInputConfig: The common config to specify a set of documents + // used as input. + BatchInputConfig *GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig `json:"batchInputConfig,omitempty"` + + // DatasetSplit: Target dataset split where the documents must be + // stored. + // + // Possible values: + // "DATASET_SPLIT_TYPE_UNSPECIFIED" - Default value if the enum is not + // set. go/protodosdonts#do-include-an-unspecified-value-in-an-enum + // "DATASET_SPLIT_TRAIN" - Identifies the train documents. + // "DATASET_SPLIT_TEST" - Identifies the test documents. + // "DATASET_SPLIT_UNASSIGNED" - Identifies the unassigned documents. + DatasetSplit string `json:"datasetSplit,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AutoSplitConfig") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AutoSplitConfig") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImport +// ConfigAutoSplitConfig: The config for auto-split. +type GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig struct { + // TrainingSplitRatio: Ratio of training dataset split. + TrainingSplitRatio float64 `json:"trainingSplitRatio,omitempty"` + + // ForceSendFields is a list of field names (e.g. "TrainingSplitRatio") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "TrainingSplitRatio") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig + var s1 struct { + TrainingSplitRatio gensupport.JSONFloat64 `json:"trainingSplitRatio"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.TrainingSplitRatio = float64(s1.TrainingSplitRatio) + return nil +} + +// GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: Response of the +// import document operation. +type GoogleCloudDocumentaiV1beta3ImportDocumentsResponse struct { +} + +// GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: The +// long-running operation metadata for the ImportProcessorVersion +// method. +type GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata struct { + // CommonMetadata: The basic metadata for the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -10968,6 +11522,9 @@ type GoogleCloudDocumentaiV1beta3ProcessRequest struct { // `pages.{page_field_name}`. FieldMask string `json:"fieldMask,omitempty"` + // GcsDocument: A raw document on Google Cloud Storage. + GcsDocument *GoogleCloudDocumentaiV1beta3GcsDocument `json:"gcsDocument,omitempty"` + // InlineDocument: An inline document proto. InlineDocument *GoogleCloudDocumentaiV1beta3Document `json:"inlineDocument,omitempty"` @@ -11582,6 +12139,54 @@ func (s *GoogleCloudDocumentaiV1beta3ReviewDocumentResponse) MarshalJSON() ([]by return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta3RevisionRef: The revision reference +// specifies which revision on the document to read. +type GoogleCloudDocumentaiV1beta3RevisionRef struct { + // LatestProcessorVersion: Reads the revision generated by the processor + // version. The format takes the full resource name of processor + // version. + // `projects/{project}/locations/{location}/processors/{processor}/proces + // sorVersions/{processorVersion}` + LatestProcessorVersion string `json:"latestProcessorVersion,omitempty"` + + // RevisionCase: Reads the revision by the predefined case. + // + // Possible values: + // "REVISION_CASE_UNSPECIFIED" - Unspecified case, fallback to read + // the LATEST_HUMAN_REVIEW. + // "LATEST_HUMAN_REVIEW" - The latest revision made by a human. + // "LATEST_TIMESTAMP" - The latest revision based on timestamp. + // "BASE_OCR_REVISION" - The first (OCR) revision. + RevisionCase string `json:"revisionCase,omitempty"` + + // RevisionId: Reads the revision given by the id. + RevisionId string `json:"revisionId,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "LatestProcessorVersion") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "LatestProcessorVersion") + // to include in API requests with the JSON null value. By default, + // fields with empty values are omitted from API requests. However, any + // field with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3RevisionRef) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3RevisionRef + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: The // long-running operation metadata for the SetDefaultProcessorVersion // method. @@ -11923,6 +12528,34 @@ type GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest struct { type GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse struct { } +type GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata struct { + // CommonMetadata: The basic metadata of the long running operation. + CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CommonMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1beta3Vertex: A vertex represents a 2D point in // the image. NOTE: the vertex coordinates are in the same scale as the // original image. @@ -15498,24 +16131,168 @@ func (c *ProjectsLocationsProcessorsUpdateDatasetCall) Do(opts ...googleapi.Call } -// method id "documentai.projects.locations.processors.dataset.getDatasetSchema": +// method id "documentai.projects.locations.processors.dataset.batchDeleteDocuments": -type ProjectsLocationsProcessorsDatasetGetDatasetSchemaCall struct { - s *Service - name string - urlParams_ gensupport.URLParams - ifNoneMatch_ string - ctx_ context.Context - header_ http.Header +type ProjectsLocationsProcessorsDatasetBatchDeleteDocumentsCall struct { + s *Service + dataset string + googleclouddocumentaiv1beta3batchdeletedocumentsrequest *GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header } -// GetDatasetSchema: Gets the `DatasetSchema` of a `Dataset`. +// BatchDeleteDocuments: Deletes a set of documents. // -// - name: The dataset schema resource name. Format: +// - dataset: The dataset resource name. Format: // projects/{project}/locations/{location}/processors/{processor}/datas -// et/datasetSchema. -func (r *ProjectsLocationsProcessorsDatasetService) GetDatasetSchema(name string) *ProjectsLocationsProcessorsDatasetGetDatasetSchemaCall { - c := &ProjectsLocationsProcessorsDatasetGetDatasetSchemaCall{s: r.s, urlParams_: make(gensupport.URLParams)} +// et. +func (r *ProjectsLocationsProcessorsDatasetService) BatchDeleteDocuments(dataset string, googleclouddocumentaiv1beta3batchdeletedocumentsrequest *GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest) *ProjectsLocationsProcessorsDatasetBatchDeleteDocumentsCall { + c := &ProjectsLocationsProcessorsDatasetBatchDeleteDocumentsCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.dataset = dataset + c.googleclouddocumentaiv1beta3batchdeletedocumentsrequest = googleclouddocumentaiv1beta3batchdeletedocumentsrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsProcessorsDatasetBatchDeleteDocumentsCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsDatasetBatchDeleteDocumentsCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsProcessorsDatasetBatchDeleteDocumentsCall) Context(ctx context.Context) *ProjectsLocationsProcessorsDatasetBatchDeleteDocumentsCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsProcessorsDatasetBatchDeleteDocumentsCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsProcessorsDatasetBatchDeleteDocumentsCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.googleclouddocumentaiv1beta3batchdeletedocumentsrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta3/{+dataset}:batchDeleteDocuments") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "dataset": c.dataset, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "documentai.projects.locations.processors.dataset.batchDeleteDocuments" call. +// Exactly one of *GoogleLongrunningOperation or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsProcessorsDatasetBatchDeleteDocumentsCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Deletes a set of documents.", + // "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/dataset:batchDeleteDocuments", + // "httpMethod": "POST", + // "id": "documentai.projects.locations.processors.dataset.batchDeleteDocuments", + // "parameterOrder": [ + // "dataset" + // ], + // "parameters": { + // "dataset": { + // "description": "Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/dataset$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta3/{+dataset}:batchDeleteDocuments", + // "request": { + // "$ref": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest" + // }, + // "response": { + // "$ref": "GoogleLongrunningOperation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "documentai.projects.locations.processors.dataset.getDatasetSchema": + +type ProjectsLocationsProcessorsDatasetGetDatasetSchemaCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// GetDatasetSchema: Gets the `DatasetSchema` of a `Dataset`. +// +// - name: The dataset schema resource name. Format: +// projects/{project}/locations/{location}/processors/{processor}/datas +// et/datasetSchema. +func (r *ProjectsLocationsProcessorsDatasetService) GetDatasetSchema(name string) *ProjectsLocationsProcessorsDatasetGetDatasetSchemaCall { + c := &ProjectsLocationsProcessorsDatasetGetDatasetSchemaCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name return c } @@ -15660,6 +16437,447 @@ func (c *ProjectsLocationsProcessorsDatasetGetDatasetSchemaCall) Do(opts ...goog } +// method id "documentai.projects.locations.processors.dataset.getDocument": + +type ProjectsLocationsProcessorsDatasetGetDocumentCall struct { + s *Service + dataset string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// GetDocument: Returns relevant fields present in the requested +// document. +// +// - dataset: The resource name of the dataset that the document belongs +// to . Format: +// projects/{project}/locations/{location}/processors/{processor}/datas +// et. +func (r *ProjectsLocationsProcessorsDatasetService) GetDocument(dataset string) *ProjectsLocationsProcessorsDatasetGetDocumentCall { + c := &ProjectsLocationsProcessorsDatasetGetDocumentCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.dataset = dataset + return c +} + +// DocumentIdGcsManagedDocIdCwDocId sets the optional parameter +// "documentId.gcsManagedDocId.cwDocId": Id of the document (indexed) +// managed by Content Warehouse. +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) DocumentIdGcsManagedDocIdCwDocId(documentIdGcsManagedDocIdCwDocId string) *ProjectsLocationsProcessorsDatasetGetDocumentCall { + c.urlParams_.Set("documentId.gcsManagedDocId.cwDocId", documentIdGcsManagedDocIdCwDocId) + return c +} + +// DocumentIdGcsManagedDocIdGcsUri sets the optional parameter +// "documentId.gcsManagedDocId.gcsUri": Required. The Cloud Storage URI +// where the actual document is stored. +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) DocumentIdGcsManagedDocIdGcsUri(documentIdGcsManagedDocIdGcsUri string) *ProjectsLocationsProcessorsDatasetGetDocumentCall { + c.urlParams_.Set("documentId.gcsManagedDocId.gcsUri", documentIdGcsManagedDocIdGcsUri) + return c +} + +// DocumentIdRevisionRefLatestProcessorVersion sets the optional +// parameter "documentId.revisionRef.latestProcessorVersion": Reads the +// revision generated by the processor version. The format takes the +// full resource name of processor version. +// `projects/{project}/locations/{location}/processors/{processor}/proces +// sorVersions/{processorVersion}` +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) DocumentIdRevisionRefLatestProcessorVersion(documentIdRevisionRefLatestProcessorVersion string) *ProjectsLocationsProcessorsDatasetGetDocumentCall { + c.urlParams_.Set("documentId.revisionRef.latestProcessorVersion", documentIdRevisionRefLatestProcessorVersion) + return c +} + +// DocumentIdRevisionRefRevisionCase sets the optional parameter +// "documentId.revisionRef.revisionCase": Reads the revision by the +// predefined case. +// +// Possible values: +// +// "REVISION_CASE_UNSPECIFIED" - Unspecified case, fallback to read +// +// the LATEST_HUMAN_REVIEW. +// +// "LATEST_HUMAN_REVIEW" - The latest revision made by a human. +// "LATEST_TIMESTAMP" - The latest revision based on timestamp. +// "BASE_OCR_REVISION" - The first (OCR) revision. +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) DocumentIdRevisionRefRevisionCase(documentIdRevisionRefRevisionCase string) *ProjectsLocationsProcessorsDatasetGetDocumentCall { + c.urlParams_.Set("documentId.revisionRef.revisionCase", documentIdRevisionRefRevisionCase) + return c +} + +// DocumentIdRevisionRefRevisionId sets the optional parameter +// "documentId.revisionRef.revisionId": Reads the revision given by the +// id. +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) DocumentIdRevisionRefRevisionId(documentIdRevisionRefRevisionId string) *ProjectsLocationsProcessorsDatasetGetDocumentCall { + c.urlParams_.Set("documentId.revisionRef.revisionId", documentIdRevisionRefRevisionId) + return c +} + +// DocumentIdUnmanagedDocIdDocId sets the optional parameter +// "documentId.unmanagedDocId.docId": Required. The id of the document. +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) DocumentIdUnmanagedDocIdDocId(documentIdUnmanagedDocIdDocId string) *ProjectsLocationsProcessorsDatasetGetDocumentCall { + c.urlParams_.Set("documentId.unmanagedDocId.docId", documentIdUnmanagedDocIdDocId) + return c +} + +// PageRangeEnd sets the optional parameter "pageRange.end": Last page +// number (one-based index) to be returned. +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) PageRangeEnd(pageRangeEnd int64) *ProjectsLocationsProcessorsDatasetGetDocumentCall { + c.urlParams_.Set("pageRange.end", fmt.Sprint(pageRangeEnd)) + return c +} + +// PageRangeStart sets the optional parameter "pageRange.start": First +// page number (one-based index) to be returned. +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) PageRangeStart(pageRangeStart int64) *ProjectsLocationsProcessorsDatasetGetDocumentCall { + c.urlParams_.Set("pageRange.start", fmt.Sprint(pageRangeStart)) + return c +} + +// ReadMask sets the optional parameter "readMask": If set, only fields +// listed here will be returned. Otherwise, all fields will be returned +// by default. +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) ReadMask(readMask string) *ProjectsLocationsProcessorsDatasetGetDocumentCall { + c.urlParams_.Set("readMask", readMask) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsDatasetGetDocumentCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) IfNoneMatch(entityTag string) *ProjectsLocationsProcessorsDatasetGetDocumentCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) Context(ctx context.Context) *ProjectsLocationsProcessorsDatasetGetDocumentCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta3/{+dataset}:getDocument") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "dataset": c.dataset, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "documentai.projects.locations.processors.dataset.getDocument" call. +// Exactly one of *GoogleCloudDocumentaiV1beta3GetDocumentResponse or +// error will be non-nil. Any non-2xx status code is an error. Response +// headers are in either +// *GoogleCloudDocumentaiV1beta3GetDocumentResponse.ServerResponse.Header +// +// or (if a response was returned at all) in +// +// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check +// whether the returned error was because http.StatusNotModified was +// returned. +func (c *ProjectsLocationsProcessorsDatasetGetDocumentCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDocumentaiV1beta3GetDocumentResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleCloudDocumentaiV1beta3GetDocumentResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Returns relevant fields present in the requested document.", + // "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/dataset:getDocument", + // "httpMethod": "GET", + // "id": "documentai.projects.locations.processors.dataset.getDocument", + // "parameterOrder": [ + // "dataset" + // ], + // "parameters": { + // "dataset": { + // "description": "Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/dataset", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/dataset$", + // "required": true, + // "type": "string" + // }, + // "documentId.gcsManagedDocId.cwDocId": { + // "deprecated": true, + // "description": "Id of the document (indexed) managed by Content Warehouse.", + // "location": "query", + // "type": "string" + // }, + // "documentId.gcsManagedDocId.gcsUri": { + // "description": "Required. The Cloud Storage URI where the actual document is stored.", + // "location": "query", + // "type": "string" + // }, + // "documentId.revisionRef.latestProcessorVersion": { + // "description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", + // "location": "query", + // "type": "string" + // }, + // "documentId.revisionRef.revisionCase": { + // "description": "Reads the revision by the predefined case.", + // "enum": [ + // "REVISION_CASE_UNSPECIFIED", + // "LATEST_HUMAN_REVIEW", + // "LATEST_TIMESTAMP", + // "BASE_OCR_REVISION" + // ], + // "enumDescriptions": [ + // "Unspecified case, fallback to read the LATEST_HUMAN_REVIEW.", + // "The latest revision made by a human.", + // "The latest revision based on timestamp.", + // "The first (OCR) revision." + // ], + // "location": "query", + // "type": "string" + // }, + // "documentId.revisionRef.revisionId": { + // "description": "Reads the revision given by the id.", + // "location": "query", + // "type": "string" + // }, + // "documentId.unmanagedDocId.docId": { + // "description": "Required. The id of the document.", + // "location": "query", + // "type": "string" + // }, + // "pageRange.end": { + // "description": "Last page number (one-based index) to be returned.", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "pageRange.start": { + // "description": "First page number (one-based index) to be returned.", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "readMask": { + // "description": "If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.", + // "format": "google-fieldmask", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "v1beta3/{+dataset}:getDocument", + // "response": { + // "$ref": "GoogleCloudDocumentaiV1beta3GetDocumentResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "documentai.projects.locations.processors.dataset.importDocuments": + +type ProjectsLocationsProcessorsDatasetImportDocumentsCall struct { + s *Service + dataset string + googleclouddocumentaiv1beta3importdocumentsrequest *GoogleCloudDocumentaiV1beta3ImportDocumentsRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// ImportDocuments: Import documents into a dataset. +// +// - dataset: The dataset resource name. Format: +// projects/{project}/locations/{location}/processors/{processor}/datas +// et. +func (r *ProjectsLocationsProcessorsDatasetService) ImportDocuments(dataset string, googleclouddocumentaiv1beta3importdocumentsrequest *GoogleCloudDocumentaiV1beta3ImportDocumentsRequest) *ProjectsLocationsProcessorsDatasetImportDocumentsCall { + c := &ProjectsLocationsProcessorsDatasetImportDocumentsCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.dataset = dataset + c.googleclouddocumentaiv1beta3importdocumentsrequest = googleclouddocumentaiv1beta3importdocumentsrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsProcessorsDatasetImportDocumentsCall) Fields(s ...googleapi.Field) *ProjectsLocationsProcessorsDatasetImportDocumentsCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsProcessorsDatasetImportDocumentsCall) Context(ctx context.Context) *ProjectsLocationsProcessorsDatasetImportDocumentsCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsProcessorsDatasetImportDocumentsCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsProcessorsDatasetImportDocumentsCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.googleclouddocumentaiv1beta3importdocumentsrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta3/{+dataset}:importDocuments") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "dataset": c.dataset, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "documentai.projects.locations.processors.dataset.importDocuments" call. +// Exactly one of *GoogleLongrunningOperation or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsProcessorsDatasetImportDocumentsCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Import documents into a dataset.", + // "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/dataset:importDocuments", + // "httpMethod": "POST", + // "id": "documentai.projects.locations.processors.dataset.importDocuments", + // "parameterOrder": [ + // "dataset" + // ], + // "parameters": { + // "dataset": { + // "description": "Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/dataset$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta3/{+dataset}:importDocuments", + // "request": { + // "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsRequest" + // }, + // "response": { + // "$ref": "GoogleLongrunningOperation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "documentai.projects.locations.processors.dataset.updateDatasetSchema": type ProjectsLocationsProcessorsDatasetUpdateDatasetSchemaCall struct { diff --git a/doubleclickbidmanager/v2/doubleclickbidmanager-api.json b/doubleclickbidmanager/v2/doubleclickbidmanager-api.json index 81c26fd5fb5..41de15cd911 100644 --- a/doubleclickbidmanager/v2/doubleclickbidmanager-api.json +++ b/doubleclickbidmanager/v2/doubleclickbidmanager-api.json @@ -15,7 +15,6 @@ "description": "DoubleClick Bid Manager API allows users to manage and create campaigns and reports.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/bid-manager/", - "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" @@ -320,7 +319,7 @@ } } }, - "revision": "20230613", + "revision": "20230703", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "ChannelGrouping": { @@ -562,6 +561,20 @@ "FULL_PATH", "PATH_ATTRIBUTION" ], + "enumDeprecated": [ + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Default value when report type is not specified or is unknown in this version.", "Standard report.", diff --git a/drive/v3/drive-api.json b/drive/v3/drive-api.json index 1460d66fd55..b10a763f427 100644 --- a/drive/v3/drive-api.json +++ b/drive/v3/drive-api.json @@ -2433,7 +2433,7 @@ } } }, - "revision": "20230610", + "revision": "20230708", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -2449,6 +2449,7 @@ "type": "boolean" }, "canCreateTeamDrives": { + "deprecated": true, "description": "Deprecated: Use `canCreateDrives` instead.", "type": "boolean" }, @@ -2545,18 +2546,22 @@ "type": "object" }, "teamDriveThemes": { + "deprecated": true, "description": "Deprecated: Use `driveThemes` instead.", "items": { "properties": { "backgroundImageLink": { + "deprecated": true, "description": "Deprecated: Use `driveThemes/backgroundImageLink` instead.", "type": "string" }, "colorRgb": { + "deprecated": true, "description": "Deprecated: Use `driveThemes/colorRgb` instead.", "type": "string" }, "id": { + "deprecated": true, "description": "Deprecated: Use `driveThemes/id` instead.", "type": "string" } @@ -2607,9 +2612,11 @@ }, "teamDrive": { "$ref": "TeamDrive", + "deprecated": true, "description": "Deprecated: Use `drive` instead." }, "teamDriveId": { + "deprecated": true, "description": "Deprecated: Use `driveId` instead.", "type": "string" }, @@ -2619,6 +2626,7 @@ "type": "string" }, "type": { + "deprecated": true, "description": "Deprecated: Use `changeType` instead.", "type": "string" } @@ -3076,6 +3084,7 @@ "type": "boolean" }, "canChangeViewersCanCopyContent": { + "deprecated": true, "description": "Deprecated: Output only.", "type": "boolean" }, @@ -3124,6 +3133,7 @@ "type": "boolean" }, "canMoveChildrenOutOfTeamDrive": { + "deprecated": true, "description": "Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.", "type": "boolean" }, @@ -3132,10 +3142,12 @@ "type": "boolean" }, "canMoveChildrenWithinTeamDrive": { + "deprecated": true, "description": "Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.", "type": "boolean" }, "canMoveItemIntoTeamDrive": { + "deprecated": true, "description": "Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.", "type": "boolean" }, @@ -3144,6 +3156,7 @@ "type": "boolean" }, "canMoveItemOutOfTeamDrive": { + "deprecated": true, "description": "Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.", "type": "boolean" }, @@ -3152,10 +3165,12 @@ "type": "boolean" }, "canMoveItemWithinTeamDrive": { + "deprecated": true, "description": "Deprecated: Output only. Use `canMoveItemWithinDrive` instead.", "type": "boolean" }, "canMoveTeamDriveItem": { + "deprecated": true, "description": "Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.", "type": "boolean" }, @@ -3172,6 +3187,7 @@ "type": "boolean" }, "canReadTeamDrive": { + "deprecated": true, "description": "Deprecated: Output only. Use `canReadDrive` instead.", "type": "boolean" }, @@ -3590,6 +3606,7 @@ "type": "boolean" }, "teamDriveId": { + "deprecated": true, "description": "Deprecated: Output only. Use `driveId` instead.", "type": "string" }, @@ -3651,6 +3668,7 @@ "type": "string" }, "viewersCanCopyContent": { + "deprecated": true, "description": "Deprecated: Use `copyRequiresWriterPermission` instead.", "type": "boolean" }, @@ -4028,22 +4046,27 @@ "type": "string" }, "teamDrivePermissionDetails": { + "deprecated": true, "description": "Output only. Deprecated: Output only. Use `permissionDetails` instead.", "items": { "properties": { "inherited": { + "deprecated": true, "description": "Deprecated: Output only. Use `permissionDetails/inherited` instead.", "type": "boolean" }, "inheritedFrom": { + "deprecated": true, "description": "Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.", "type": "string" }, "role": { + "deprecated": true, "description": "Deprecated: Output only. Use `permissionDetails/role` instead.", "type": "string" }, "teamDrivePermissionType": { + "deprecated": true, "description": "Deprecated: Output only. Use `permissionDetails/permissionType` instead.", "type": "string" } @@ -4370,6 +4393,7 @@ "type": "boolean" }, "canRemoveChildren": { + "deprecated": true, "description": "Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.", "type": "boolean" }, diff --git a/iam/v1/iam-api.json b/iam/v1/iam-api.json index 533e7731c7e..d7063ffa4de 100644 --- a/iam/v1/iam-api.json +++ b/iam/v1/iam-api.json @@ -2883,7 +2883,7 @@ } } }, - "revision": "20230622", + "revision": "20230710", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AdminAuditData": { @@ -3244,13 +3244,13 @@ ], "enumDescriptions": [ "No assertion claims behavior specified.", - "Merge the UserInfo Endpoint Claims with ID Token Claims, preferring UserInfo Claim Values for the same Claim Name. Only possible for flows granting an Access Token, which comprise only the Authorization Code Flow at the moment.", + "Merge the UserInfo Endpoint Claims with ID Token Claims, preferring UserInfo Claim Values for the same Claim Name. This option is available only for the Authorization Code Flow.", "Only include ID Token Claims." ], "type": "string" }, "responseType": { - "description": "Required. The Response Type to request for in the OIDC Authorization Request for web sign-in.", + "description": "Required. The Response Type to request for in the OIDC Authorization Request for web sign-in. The `CODE` Response Type is recommended to avoid the Implicit Flow, for security reasons.", "enum": [ "RESPONSE_TYPE_UNSPECIFIED", "CODE", @@ -3675,6 +3675,7 @@ "type": "string" }, "onlyInPredefinedRoles": { + "deprecated": true, "type": "boolean" }, "primaryPermission": { @@ -3971,6 +3972,7 @@ "type": "string" }, "etag": { + "deprecated": true, "description": "Deprecated. Do not use.", "format": "byte", "type": "string" @@ -4109,6 +4111,7 @@ "id": "SignBlobRequest", "properties": { "bytesToSign": { + "deprecated": true, "description": "Required. Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The bytes to sign.", "format": "byte", "type": "string" @@ -4121,10 +4124,12 @@ "id": "SignBlobResponse", "properties": { "keyId": { + "deprecated": true, "description": "Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The id of the key used to sign the blob.", "type": "string" }, "signature": { + "deprecated": true, "description": "Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The signed blob.", "format": "byte", "type": "string" @@ -4137,6 +4142,7 @@ "id": "SignJwtRequest", "properties": { "payload": { + "deprecated": true, "description": "Required. Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The JWT payload to sign. Must be a serialized JSON object that contains a JWT Claims Set. For example: `{\"sub\": \"user@example.com\", \"iat\": 313435}` If the JWT Claims Set contains an expiration time (`exp`) claim, it must be an integer timestamp that is not in the past and no more than 12 hours in the future. If the JWT Claims Set does not contain an expiration time (`exp`) claim, this claim is added automatically, with a timestamp that is 1 hour in the future.", "type": "string" } @@ -4148,10 +4154,12 @@ "id": "SignJwtResponse", "properties": { "keyId": { + "deprecated": true, "description": "Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The id of the key used to sign the JWT.", "type": "string" }, "signedJwt": { + "deprecated": true, "description": "Deprecated. [Migrate to Service Account Credentials API](https://cloud.google.com/iam/help/credentials/migrate-api). The signed JWT.", "type": "string" } @@ -4311,6 +4319,12 @@ "description": "A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.", "type": "string" }, + "expireTime": { + "description": "Output only. Time after which the workforce pool will be permanently purged and cannot be recovered.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "name": { "description": "Output only. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`", "readOnly": true, @@ -4370,6 +4384,12 @@ "description": "A user-specified display name for the provider. Cannot exceed 32 characters.", "type": "string" }, + "expireTime": { + "description": "Output only. Time after which the workload pool provider will be permanently purged and cannot be recovered.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "name": { "description": "Output only. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`", "readOnly": true, @@ -4466,18 +4486,10 @@ "description": "A display name for the pool. Cannot exceed 32 characters.", "type": "string" }, - "identityMode": { - "description": "Immutable. The identity mode of the pool.", - "enum": [ - "IDENTITY_MODE_UNSPECIFIED", - "FEDERATION_ONLY", - "TRUST_DOMAIN" - ], - "enumDescriptions": [ - "Existing pools will be in this mode. For existing worklod identity pools created through the public API, they will act as if they are set to FEDERATION_ONLY.", - "With FEDERATION_ONLY mode, providers can be created at the root level within the pool. Attribute mappings must specify a \"google.subject\" claim that specifies the identity of the federation workload. Namespace or any sub-namespace resources is not allowed with this mode.", - "With TRUST_DOMAIN mode, providers can be created at the root level within the pool. Attribute mappings must specify the \"google.namespace\" and \"google.workload_identifier\" claims that, respectively, specify the namespace and individual sub-namespace identifier for the workload. Namespaces and sub-Namespace resources are allowed." - ], + "expireTime": { + "description": "Output only. Time after which the workload identity pool will be permanently purged and cannot be recovered.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, "name": { @@ -4540,6 +4552,12 @@ "description": "A display name for the provider. Cannot exceed 32 characters.", "type": "string" }, + "expireTime": { + "description": "Output only. Time after which the workload identity pool provider will be permanently purged and cannot be recovered.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "name": { "description": "Output only. The resource name of the provider.", "readOnly": true, diff --git a/iam/v1/iam-gen.go b/iam/v1/iam-gen.go index f1ea03e96de..a8c12b23faa 100644 --- a/iam/v1/iam-gen.go +++ b/iam/v1/iam-gen.go @@ -1277,14 +1277,14 @@ type GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig struct { // behavior specified. // "MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS" - Merge the UserInfo // Endpoint Claims with ID Token Claims, preferring UserInfo Claim - // Values for the same Claim Name. Only possible for flows granting an - // Access Token, which comprise only the Authorization Code Flow at the - // moment. + // Values for the same Claim Name. This option is available only for the + // Authorization Code Flow. // "ONLY_ID_TOKEN_CLAIMS" - Only include ID Token Claims. AssertionClaimsBehavior string `json:"assertionClaimsBehavior,omitempty"` // ResponseType: Required. The Response Type to request for in the OIDC - // Authorization Request for web sign-in. + // Authorization Request for web sign-in. The `CODE` Response Type is + // recommended to avoid the Implicit Flow, for security reasons. // // Possible values: // "RESPONSE_TYPE_UNSPECIFIED" - No Response Type specified. @@ -3287,6 +3287,10 @@ type WorkforcePool struct { // Cloud Console. Cannot exceed 32 characters. DisplayName string `json:"displayName,omitempty"` + // ExpireTime: Output only. Time after which the workforce pool will be + // permanently purged and cannot be recovered. + ExpireTime string `json:"expireTime,omitempty"` + // Name: Output only. The resource name of the pool. Format: // `locations/{location}/workforcePools/{workforce_pool_id}` Name string `json:"name,omitempty"` @@ -3428,6 +3432,10 @@ type WorkforcePoolProvider struct { // exceed 32 characters. DisplayName string `json:"displayName,omitempty"` + // ExpireTime: Output only. Time after which the workload pool provider + // will be permanently purged and cannot be recovered. + ExpireTime string `json:"expireTime,omitempty"` + // Name: Output only. The resource name of the provider. Format: // `locations/{location}/workforcePools/{workforce_pool_id}/providers/{pr // ovider_id}` @@ -3555,24 +3563,9 @@ type WorkloadIdentityPool struct { // characters. DisplayName string `json:"displayName,omitempty"` - // IdentityMode: Immutable. The identity mode of the pool. - // - // Possible values: - // "IDENTITY_MODE_UNSPECIFIED" - Existing pools will be in this mode. - // For existing worklod identity pools created through the public API, - // they will act as if they are set to FEDERATION_ONLY. - // "FEDERATION_ONLY" - With FEDERATION_ONLY mode, providers can be - // created at the root level within the pool. Attribute mappings must - // specify a "google.subject" claim that specifies the identity of the - // federation workload. Namespace or any sub-namespace resources is not - // allowed with this mode. - // "TRUST_DOMAIN" - With TRUST_DOMAIN mode, providers can be created - // at the root level within the pool. Attribute mappings must specify - // the "google.namespace" and "google.workload_identifier" claims that, - // respectively, specify the namespace and individual sub-namespace - // identifier for the workload. Namespaces and sub-Namespace resources - // are allowed. - IdentityMode string `json:"identityMode,omitempty"` + // ExpireTime: Output only. Time after which the workload identity pool + // will be permanently purged and cannot be recovered. + ExpireTime string `json:"expireTime,omitempty"` // Name: Output only. The resource name of the pool. Name string `json:"name,omitempty"` @@ -3706,6 +3699,10 @@ type WorkloadIdentityPoolProvider struct { // characters. DisplayName string `json:"displayName,omitempty"` + // ExpireTime: Output only. Time after which the workload identity pool + // provider will be permanently purged and cannot be recovered. + ExpireTime string `json:"expireTime,omitempty"` + // Name: Output only. The resource name of the provider. Name string `json:"name,omitempty"` diff --git a/iam/v2/iam-api.json b/iam/v2/iam-api.json index b88fe1792b8..8f85af2f099 100644 --- a/iam/v2/iam-api.json +++ b/iam/v2/iam-api.json @@ -293,7 +293,7 @@ } } }, - "revision": "20230119", + "revision": "20230710", "rootUrl": "https://iam.googleapis.com/", "schemas": { "GoogleIamAdminV1AuditData": { @@ -477,7 +477,7 @@ "type": "string" }, "etag": { - "description": "An opaque tag that identifies the current version of the `Policy`. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a CreatePolicy request, the value is ignored.", + "description": "An opaque tag that identifies the current version of the `Policy`. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a CreatePolicyRequest, the value is ignored.", "type": "string" }, "kind": { diff --git a/iam/v2/iam-gen.go b/iam/v2/iam-gen.go index 6df7841dd53..01786334f72 100644 --- a/iam/v2/iam-gen.go +++ b/iam/v2/iam-gen.go @@ -491,7 +491,7 @@ type GoogleIamV2Policy struct { // Etag: An opaque tag that identifies the current version of the // `Policy`. IAM uses this value to help manage concurrent updates, so // they do not cause one update to be overwritten by another. If this - // field is present in a CreatePolicy request, the value is ignored. + // field is present in a CreatePolicyRequest, the value is ignored. Etag string `json:"etag,omitempty"` // Kind: Output only. The kind of the `Policy`. Always contains the diff --git a/iam/v2beta/iam-api.json b/iam/v2beta/iam-api.json index 94b89429ca9..95590f86d51 100644 --- a/iam/v2beta/iam-api.json +++ b/iam/v2beta/iam-api.json @@ -293,7 +293,7 @@ } } }, - "revision": "20220713", + "revision": "20230710", "rootUrl": "https://iam.googleapis.com/", "schemas": { "GoogleIamAdminV1AuditData": { @@ -477,7 +477,7 @@ "type": "string" }, "etag": { - "description": "An opaque tag that identifies the current version of the `Policy`. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a CreatePolicy request, the value is ignored.", + "description": "An opaque tag that identifies the current version of the `Policy`. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a CreatePolicyRequest, the value is ignored.", "type": "string" }, "kind": { diff --git a/iam/v2beta/iam-gen.go b/iam/v2beta/iam-gen.go index 3a560af6ae2..f5d323233ff 100644 --- a/iam/v2beta/iam-gen.go +++ b/iam/v2beta/iam-gen.go @@ -492,7 +492,7 @@ type GoogleIamV2betaPolicy struct { // Etag: An opaque tag that identifies the current version of the // `Policy`. IAM uses this value to help manage concurrent updates, so // they do not cause one update to be overwritten by another. If this - // field is present in a CreatePolicy request, the value is ignored. + // field is present in a CreatePolicyRequest, the value is ignored. Etag string `json:"etag,omitempty"` // Kind: Output only. The kind of the `Policy`. Always contains the diff --git a/identitytoolkit/v1/identitytoolkit-api.json b/identitytoolkit/v1/identitytoolkit-api.json index 51039c5cf23..d73533f8941 100644 --- a/identitytoolkit/v1/identitytoolkit-api.json +++ b/identitytoolkit/v1/identitytoolkit-api.json @@ -1239,7 +1239,7 @@ } } }, - "revision": "20230531", + "revision": "20230707", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitV1Argon2Parameters": { @@ -1376,6 +1376,7 @@ "id": "GoogleCloudIdentitytoolkitV1CreateAuthUriRequest", "properties": { "appId": { + "deprecated": true, "type": "string" }, "authFlowType": { @@ -1406,6 +1407,7 @@ "type": "string" }, "oauthConsumerKey": { + "deprecated": true, "type": "string" }, "oauthScope": { @@ -1413,9 +1415,11 @@ "type": "string" }, "openidRealm": { + "deprecated": true, "type": "string" }, "otaApp": { + "deprecated": true, "type": "string" }, "providerId": { @@ -1438,6 +1442,7 @@ "id": "GoogleCloudIdentitytoolkitV1CreateAuthUriResponse", "properties": { "allProviders": { + "deprecated": true, "items": { "type": "string" }, @@ -1456,6 +1461,7 @@ "type": "boolean" }, "kind": { + "deprecated": true, "type": "string" }, "providerId": { @@ -1516,6 +1522,7 @@ "id": "GoogleCloudIdentitytoolkitV1DeleteAccountRequest", "properties": { "delegatedProjectNumber": { + "deprecated": true, "format": "int64", "type": "string" }, @@ -1543,6 +1550,7 @@ "id": "GoogleCloudIdentitytoolkitV1DeleteAccountResponse", "properties": { "kind": { + "deprecated": true, "type": "string" } }, @@ -1553,6 +1561,7 @@ "id": "GoogleCloudIdentitytoolkitV1DownloadAccountResponse", "properties": { "kind": { + "deprecated": true, "type": "string" }, "nextPageToken": { @@ -1673,6 +1682,7 @@ "id": "GoogleCloudIdentitytoolkitV1GetAccountInfoRequest", "properties": { "delegatedProjectNumber": { + "deprecated": true, "format": "int64", "type": "string" }, @@ -1731,6 +1741,7 @@ "id": "GoogleCloudIdentitytoolkitV1GetAccountInfoResponse", "properties": { "kind": { + "deprecated": true, "type": "string" }, "users": { @@ -1768,6 +1779,7 @@ "type": "string" }, "challenge": { + "deprecated": true, "type": "string" }, "clientType": { @@ -1839,6 +1851,17 @@ "VERIFY_AND_CHANGE_EMAIL", "REVERT_SECOND_FACTOR_ADDITION" ], + "enumDeprecated": [ + false, + false, + true, + true, + false, + true, + false, + false, + true + ], "enumDescriptions": [ "Oob code type is not specified.", "reset password", @@ -1880,6 +1903,7 @@ "type": "string" }, "kind": { + "deprecated": true, "type": "string" }, "oobCode": { @@ -1963,6 +1987,7 @@ "id": "GoogleCloudIdentitytoolkitV1GetRecaptchaParamResponse", "properties": { "kind": { + "deprecated": true, "type": "string" }, "producerProjectNumber": { @@ -1974,6 +1999,7 @@ "type": "string" }, "recaptchaStoken": { + "deprecated": true, "type": "string" } }, @@ -2366,6 +2392,7 @@ "type": "string" }, "kind": { + "deprecated": true, "type": "string" }, "mfaInfo": { @@ -2386,6 +2413,17 @@ "VERIFY_AND_CHANGE_EMAIL", "REVERT_SECOND_FACTOR_ADDITION" ], + "enumDeprecated": [ + false, + false, + true, + true, + false, + true, + false, + false, + true + ], "enumDescriptions": [ "Oob code type is not specified.", "reset password", @@ -2457,6 +2495,7 @@ "id": "GoogleCloudIdentitytoolkitV1SetAccountInfoRequest", "properties": { "captchaChallenge": { + "deprecated": true, "type": "string" }, "captchaResponse": { @@ -2473,6 +2512,7 @@ "type": "string" }, "delegatedProjectNumber": { + "deprecated": true, "format": "int64", "type": "string" }, @@ -2529,6 +2569,7 @@ "type": "string" }, "instanceId": { + "deprecated": true, "type": "string" }, "lastLoginAt": { @@ -2600,10 +2641,12 @@ "id": "GoogleCloudIdentitytoolkitV1SetAccountInfoResponse", "properties": { "displayName": { + "deprecated": true, "description": "The account's display name.", "type": "string" }, "email": { + "deprecated": true, "description": "The account's email address.", "type": "string" }, @@ -2621,6 +2664,7 @@ "type": "string" }, "kind": { + "deprecated": true, "type": "string" }, "localId": { @@ -2632,10 +2676,12 @@ "type": "string" }, "passwordHash": { + "deprecated": true, "description": "Deprecated. No actual password hash is currently returned.", "type": "string" }, "photoUrl": { + "deprecated": true, "description": "The user's photo URL for the account's profile photo.", "type": "string" }, @@ -2658,10 +2704,12 @@ "id": "GoogleCloudIdentitytoolkitV1SignInWithCustomTokenRequest", "properties": { "delegatedProjectNumber": { + "deprecated": true, "format": "int64", "type": "string" }, "instanceId": { + "deprecated": true, "type": "string" }, "returnSecureToken": { @@ -2697,6 +2745,7 @@ "type": "boolean" }, "kind": { + "deprecated": true, "type": "string" }, "refreshToken": { @@ -2751,6 +2800,7 @@ "type": "boolean" }, "kind": { + "deprecated": true, "type": "string" }, "localId": { @@ -2872,9 +2922,11 @@ "id": "GoogleCloudIdentitytoolkitV1SignInWithIdpRequest", "properties": { "autoCreate": { + "deprecated": true, "type": "boolean" }, "delegatedProjectNumber": { + "deprecated": true, "format": "int64", "type": "string" }, @@ -2883,6 +2935,7 @@ "type": "string" }, "pendingIdToken": { + "deprecated": true, "type": "string" }, "pendingToken": { @@ -2974,6 +3027,7 @@ "type": "string" }, "inputEmail": { + "deprecated": true, "type": "string" }, "isNewUser": { @@ -2981,6 +3035,7 @@ "type": "boolean" }, "kind": { + "deprecated": true, "type": "string" }, "language": { @@ -3011,6 +3066,7 @@ "type": "boolean" }, "needEmail": { + "deprecated": true, "type": "boolean" }, "nickName": { @@ -3093,6 +3149,7 @@ "id": "GoogleCloudIdentitytoolkitV1SignInWithPasswordRequest", "properties": { "captchaChallenge": { + "deprecated": true, "type": "string" }, "captchaResponse": { @@ -3116,6 +3173,7 @@ "type": "string" }, "delegatedProjectNumber": { + "deprecated": true, "format": "int64", "type": "string" }, @@ -3124,9 +3182,11 @@ "type": "string" }, "idToken": { + "deprecated": true, "type": "string" }, "instanceId": { + "deprecated": true, "type": "string" }, "password": { @@ -3134,6 +3194,7 @@ "type": "string" }, "pendingIdToken": { + "deprecated": true, "type": "string" }, "recaptchaVersion": { @@ -3181,6 +3242,7 @@ "type": "string" }, "kind": { + "deprecated": true, "type": "string" }, "localId": { @@ -3199,13 +3261,16 @@ "type": "string" }, "oauthAccessToken": { + "deprecated": true, "description": "The OAuth2 access token.", "type": "string" }, "oauthAuthorizationCode": { + "deprecated": true, "type": "string" }, "oauthExpireIn": { + "deprecated": true, "description": "The access token expiration time in seconds.", "format": "int32", "type": "integer" @@ -3219,6 +3284,7 @@ "type": "string" }, "registered": { + "deprecated": true, "description": "Whether the email is for an existing account. Always true.", "type": "boolean" }, @@ -3245,6 +3311,7 @@ "type": "string" }, "operation": { + "deprecated": true, "enum": [ "VERIFY_OP_UNSPECIFIED", "SIGN_UP_OR_IN", @@ -3339,6 +3406,7 @@ "id": "GoogleCloudIdentitytoolkitV1SignUpRequest", "properties": { "captchaChallenge": { + "deprecated": true, "type": "string" }, "captchaResponse": { @@ -3382,6 +3450,7 @@ "type": "string" }, "instanceId": { + "deprecated": true, "type": "string" }, "localId": { @@ -3513,6 +3582,7 @@ "type": "integer" }, "delegatedProjectNumber": { + "deprecated": true, "format": "int64", "type": "string" }, @@ -3594,6 +3664,7 @@ "type": "array" }, "kind": { + "deprecated": true, "type": "string" } }, diff --git a/identitytoolkit/v2/identitytoolkit-api.json b/identitytoolkit/v2/identitytoolkit-api.json index ccebc56856b..a90fae4d296 100644 --- a/identitytoolkit/v2/identitytoolkit-api.json +++ b/identitytoolkit/v2/identitytoolkit-api.json @@ -1655,7 +1655,7 @@ } } }, - "revision": "20230531", + "revision": "20230707", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitAdminV2AllowByDefault": { @@ -2477,6 +2477,7 @@ "type": "boolean" }, "token": { + "deprecated": true, "description": "Do not use. The `token` response type is not supported at the moment.", "type": "boolean" } @@ -3279,6 +3280,25 @@ "$ref": "GoogleCloudIdentitytoolkitV2CustomStrengthOptions", "description": "The custom strength options enforced by the password policy." }, + "enforcementState": { + "description": "Output only. Which enforcement mode to use for the password policy.", + "enum": [ + "ENFORCEMENT_STATE_UNSPECIFIED", + "OFF", + "ENFORCE" + ], + "enumDescriptions": [ + "Enforcement state has not been set.", + "Password Policy will not be used on the project.", + "Passwords non-compliant with the password policy will be rejected with an error thrown." + ], + "readOnly": true, + "type": "string" + }, + "forceUpgradeOnSignin": { + "description": "Users must have a password compliant with the password policy to sign-in.", + "type": "boolean" + }, "schemaVersion": { "description": "Output only. schema version number for the password policy", "format": "int32", diff --git a/identitytoolkit/v2/identitytoolkit-gen.go b/identitytoolkit/v2/identitytoolkit-gen.go index 248563c86a2..1c965709eee 100644 --- a/identitytoolkit/v2/identitytoolkit-gen.go +++ b/identitytoolkit/v2/identitytoolkit-gen.go @@ -3089,6 +3089,21 @@ type GoogleCloudIdentitytoolkitV2PasswordPolicy struct { // password policy. CustomStrengthOptions *GoogleCloudIdentitytoolkitV2CustomStrengthOptions `json:"customStrengthOptions,omitempty"` + // EnforcementState: Output only. Which enforcement mode to use for the + // password policy. + // + // Possible values: + // "ENFORCEMENT_STATE_UNSPECIFIED" - Enforcement state has not been + // set. + // "OFF" - Password Policy will not be used on the project. + // "ENFORCE" - Passwords non-compliant with the password policy will + // be rejected with an error thrown. + EnforcementState string `json:"enforcementState,omitempty"` + + // ForceUpgradeOnSignin: Users must have a password compliant with the + // password policy to sign-in. + ForceUpgradeOnSignin bool `json:"forceUpgradeOnSignin,omitempty"` + // SchemaVersion: Output only. schema version number for the password // policy SchemaVersion int64 `json:"schemaVersion,omitempty"` diff --git a/logging/v2/logging-api.json b/logging/v2/logging-api.json index 7baf442ceb1..3b1ca3aafe7 100644 --- a/logging/v2/logging-api.json +++ b/logging/v2/logging-api.json @@ -7077,7 +7077,7 @@ } } }, - "revision": "20230623", + "revision": "20230706", "rootUrl": "https://logging.googleapis.com/", "schemas": { "BigQueryDataset": { @@ -7185,7 +7185,7 @@ "id": "CmekSettings", "properties": { "kmsKeyName": { - "description": "The resource name for the configured Cloud KMS key.KMS key name format: \"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]\" For example:\"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key\"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", + "description": "The resource name for the configured Cloud KMS key.KMS key name format: \"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]\" For example:\"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key\"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.", "type": "string" }, "kmsKeyVersionName": { @@ -7725,6 +7725,7 @@ "type": "string" }, "projectIds": { + "deprecated": true, "description": "Optional. Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: \"my-project-1A\".", "items": { "type": "string" @@ -8025,6 +8026,7 @@ }, "metadata": { "$ref": "MonitoredResourceMetadata", + "deprecated": true, "description": "Output only. Deprecated. This field is not used by Logging. Any value written to it is cleared.", "readOnly": true }, @@ -8288,6 +8290,7 @@ "type": "string" }, "version": { + "deprecated": true, "description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.", "enum": [ "V2", @@ -8348,6 +8351,7 @@ "type": "string" }, "outputVersionFormat": { + "deprecated": true, "description": "Deprecated. This field is unused.", "enum": [ "VERSION_FORMAT_UNSPECIFIED", @@ -8544,6 +8548,7 @@ "type": "string" }, "launchStage": { + "deprecated": true, "description": "Deprecated. Must use the MetricDescriptor.launch_stage instead.", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", @@ -8890,7 +8895,7 @@ "type": "string" }, "storageLocation": { - "description": "Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example europe-west1. This setting does not affect the location of custom log buckets.", + "description": "Optional. The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided. The use cases includes: The location of _Default and _Required log bucket for newly created projects and folders.Example value: europe-west1.Note: this setting does not affect the location of resources where a location is explicitly provided when created, such as custom log buckets.", "type": "string" } }, diff --git a/logging/v2/logging-gen.go b/logging/v2/logging-gen.go index 39799cc1169..6e82da6ca8f 100644 --- a/logging/v2/logging-gen.go +++ b/logging/v2/logging-gen.go @@ -986,7 +986,7 @@ type CmekSettings struct { // example:"projects/my-project/locations/us-central1/keyRings/my-ring/cr // yptoKeys/my-key"To enable CMEK for the Log Router, set this field to // a valid kms_key_name for which the associated service account has the - // required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the + // needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the // key.The Cloud KMS key used by the Log Router can be updated by // changing the kms_key_name to a new valid key name or disabled by // setting the key name to an empty string. Encryption operations that @@ -3948,10 +3948,13 @@ type Settings struct { // Name: Output only. The resource name of the settings. Name string `json:"name,omitempty"` - // StorageLocation: Optional. The Cloud region that will be used for - // _Default and _Required log buckets for newly created projects and - // folders. For example europe-west1. This setting does not affect the - // location of custom log buckets. + // StorageLocation: Optional. The storage location that Cloud Logging + // will use to create new resources when a location is needed but not + // explicitly provided. The use cases includes: The location of _Default + // and _Required log bucket for newly created projects and + // folders.Example value: europe-west1.Note: this setting does not + // affect the location of resources where a location is explicitly + // provided when created, such as custom log buckets. StorageLocation string `json:"storageLocation,omitempty"` // ServerResponse contains the HTTP response code and headers from the diff --git a/run/v1/run-api.json b/run/v1/run-api.json index dad521077c1..e3dbc99368c 100644 --- a/run/v1/run-api.json +++ b/run/v1/run-api.json @@ -2289,7 +2289,7 @@ } } }, - "revision": "20230625", + "revision": "20230709", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -2767,7 +2767,7 @@ "id": "EmptyDirVolumeSource", "properties": { "medium": { - "description": "The medium on which the data is stored. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir +optional", + "description": "The medium on which the data is stored. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", "type": "string" }, "sizeLimit": { diff --git a/run/v1/run-gen.go b/run/v1/run-gen.go index 66c7fe7cea8..5c44a3aa31e 100644 --- a/run/v1/run-gen.go +++ b/run/v1/run-gen.go @@ -1231,7 +1231,6 @@ type EmptyDirVolumeSource struct { // which means to use the node's default medium. Must be an empty string // (default) or Memory. More info: // https://kubernetes.io/docs/concepts/storage/volumes#emptydir - // +optional Medium string `json:"medium,omitempty"` // SizeLimit: Limit on the storage usable by this EmptyDir volume. The diff --git a/speech/v1/speech-api.json b/speech/v1/speech-api.json index b420208901e..4b2ae40db65 100644 --- a/speech/v1/speech-api.json +++ b/speech/v1/speech-api.json @@ -524,7 +524,7 @@ } } }, - "revision": "20230418", + "revision": "20230710", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { @@ -970,6 +970,7 @@ "type": "object" }, "RecognitionMetadata": { + "deprecated": true, "description": "Description of audio data to be recognized.", "id": "RecognitionMetadata", "properties": { @@ -1133,6 +1134,7 @@ "type": "integer" }, "speakerTag": { + "deprecated": true, "description": "Output only. Unused.", "format": "int32", "readOnly": true, @@ -1317,6 +1319,7 @@ "type": "string" }, "speakerTag": { + "deprecated": true, "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to diarization_speaker_count. speaker_tag is set if enable_speaker_diarization = 'true' and only for the top alternative. Note: Use speaker_label instead.", "format": "int32", "readOnly": true, diff --git a/speech/v1p1beta1/speech-api.json b/speech/v1p1beta1/speech-api.json index f0997c51a8e..93e700bf71a 100644 --- a/speech/v1p1beta1/speech-api.json +++ b/speech/v1p1beta1/speech-api.json @@ -524,7 +524,7 @@ } } }, - "revision": "20230418", + "revision": "20230710", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { @@ -904,6 +904,7 @@ "description": "Config to enable speaker diarization and set additional parameters to make diarization better suited for your application. Note: When this is enabled, we send all the words from the beginning of the audio for the top alternative in every consecutive STREAMING responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. For non-streaming requests, the diarization results will be provided only in the top alternative of the FINAL SpeechRecognitionResult." }, "diarizationSpeakerCount": { + "deprecated": true, "description": "If set, specifies the estimated number of speakers in the conversation. Defaults to '2'. Ignored unless enable_speaker_diarization is set to true. Note: Use diarization_config instead.", "format": "int32", "type": "integer" @@ -917,6 +918,7 @@ "type": "boolean" }, "enableSpeakerDiarization": { + "deprecated": true, "description": "If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_label provided in the WordInfo. Note: Use diarization_config instead.", "type": "boolean" }, @@ -1009,6 +1011,7 @@ "type": "object" }, "RecognitionMetadata": { + "deprecated": true, "description": "Description of audio data to be recognized.", "id": "RecognitionMetadata", "properties": { @@ -1064,6 +1067,7 @@ "type": "string" }, "obfuscatedId": { + "deprecated": true, "description": "Obfuscated (privacy-protected) ID of the user, to identify number of unique users using the service.", "format": "int64", "type": "string" @@ -1177,6 +1181,7 @@ "type": "integer" }, "speakerTag": { + "deprecated": true, "description": "Output only. Unused.", "format": "int32", "readOnly": true, @@ -1375,6 +1380,7 @@ "type": "string" }, "speakerTag": { + "deprecated": true, "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to diarization_speaker_count. speaker_tag is set if enable_speaker_diarization = 'true' and only for the top alternative. Note: Use speaker_label instead.", "format": "int32", "readOnly": true, diff --git a/storage/v1/storage-api.json b/storage/v1/storage-api.json index b0649447b71..62120711818 100644 --- a/storage/v1/storage-api.json +++ b/storage/v1/storage-api.json @@ -26,7 +26,7 @@ "description": "Stores and retrieves potentially large, immutable data objects.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/storage/docs/json_api/", - "etag": "\"383236363234373537353532383237373333\"", + "etag": "\"39353535313838393033333032363632303533\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -1311,7 +1311,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -1357,7 +1357,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -1399,7 +1399,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -1444,7 +1444,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -1493,7 +1493,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -1545,7 +1545,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -1588,7 +1588,7 @@ "type": "string" }, "destinationObject": { - "description": "Name of the new object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the new object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -1662,7 +1662,7 @@ ], "parameters": { "destinationBucket": { - "description": "Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -1773,7 +1773,7 @@ "type": "string" }, "sourceObject": { - "description": "Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -1843,7 +1843,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -1907,7 +1907,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -1967,7 +1967,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -2054,7 +2054,7 @@ "type": "string" }, "name": { - "description": "Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "query", "type": "string" }, @@ -2252,7 +2252,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -2332,7 +2332,7 @@ "type": "string" }, "destinationObject": { - "description": "Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -2443,7 +2443,7 @@ "type": "string" }, "sourceObject": { - "description": "Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -2489,7 +2489,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -2536,7 +2536,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -2612,7 +2612,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -3010,7 +3010,7 @@ } } }, - "revision": "20230617", + "revision": "20230710", "rootUrl": "https://storage.googleapis.com/", "schemas": { "Bucket": { diff --git a/storage/v1/storage-gen.go b/storage/v1/storage-gen.go index 9f04327d928..69a6e41e7cc 100644 --- a/storage/v1/storage-gen.go +++ b/storage/v1/storage-gen.go @@ -7261,7 +7261,7 @@ type ObjectAccessControlsDeleteCall struct { // allAuthenticatedUsers. // - object: Name of the object. For information about how to URL encode // object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectAccessControlsService) Delete(bucket string, object string, entity string) *ObjectAccessControlsDeleteCall { c := &ObjectAccessControlsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.bucket = bucket @@ -7376,7 +7376,7 @@ func (c *ObjectAccessControlsDeleteCall) Do(opts ...googleapi.CallOption) error // "type": "string" // }, // "object": { - // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -7418,7 +7418,7 @@ type ObjectAccessControlsGetCall struct { // allAuthenticatedUsers. // - object: Name of the object. For information about how to URL encode // object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectAccessControlsService) Get(bucket string, object string, entity string) *ObjectAccessControlsGetCall { c := &ObjectAccessControlsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.bucket = bucket @@ -7571,7 +7571,7 @@ func (c *ObjectAccessControlsGetCall) Do(opts ...googleapi.CallOption) (*ObjectA // "type": "string" // }, // "object": { - // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -7611,7 +7611,7 @@ type ObjectAccessControlsInsertCall struct { // - bucket: Name of a bucket. // - object: Name of the object. For information about how to URL encode // object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectAccessControlsService) Insert(bucket string, object string, objectaccesscontrol *ObjectAccessControl) *ObjectAccessControlsInsertCall { c := &ObjectAccessControlsInsertCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.bucket = bucket @@ -7748,7 +7748,7 @@ func (c *ObjectAccessControlsInsertCall) Do(opts ...googleapi.CallOption) (*Obje // "type": "string" // }, // "object": { - // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -7791,7 +7791,7 @@ type ObjectAccessControlsListCall struct { // - bucket: Name of a bucket. // - object: Name of the object. For information about how to URL encode // object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectAccessControlsService) List(bucket string, object string) *ObjectAccessControlsListCall { c := &ObjectAccessControlsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.bucket = bucket @@ -7935,7 +7935,7 @@ func (c *ObjectAccessControlsListCall) Do(opts ...googleapi.CallOption) (*Object // "type": "string" // }, // "object": { - // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -7979,7 +7979,7 @@ type ObjectAccessControlsPatchCall struct { // allAuthenticatedUsers. // - object: Name of the object. For information about how to URL encode // object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectAccessControlsService) Patch(bucket string, object string, entity string, objectaccesscontrol *ObjectAccessControl) *ObjectAccessControlsPatchCall { c := &ObjectAccessControlsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.bucket = bucket @@ -8125,7 +8125,7 @@ func (c *ObjectAccessControlsPatchCall) Do(opts ...googleapi.CallOption) (*Objec // "type": "string" // }, // "object": { - // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -8172,7 +8172,7 @@ type ObjectAccessControlsUpdateCall struct { // allAuthenticatedUsers. // - object: Name of the object. For information about how to URL encode // object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectAccessControlsService) Update(bucket string, object string, entity string, objectaccesscontrol *ObjectAccessControl) *ObjectAccessControlsUpdateCall { c := &ObjectAccessControlsUpdateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.bucket = bucket @@ -8318,7 +8318,7 @@ func (c *ObjectAccessControlsUpdateCall) Do(opts ...googleapi.CallOption) (*Obje // "type": "string" // }, // "object": { - // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -8363,7 +8363,8 @@ type ObjectsComposeCall struct { // objects. The destination object is stored in this bucket. // - destinationObject: Name of the new object. For information about // how to URL encode object names to be path safe, see Encoding URI -// Path Parts (http://cloud/storage/docs/request-endpoints#encoding). +// Path Parts +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectsService) Compose(destinationBucket string, destinationObject string, composerequest *ComposeRequest) *ObjectsComposeCall { c := &ObjectsComposeCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.destinationBucket = destinationBucket @@ -8546,7 +8547,7 @@ func (c *ObjectsComposeCall) Do(opts ...googleapi.CallOption) (*Object, error) { // "type": "string" // }, // "destinationObject": { - // "description": "Name of the new object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the new object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -8632,7 +8633,7 @@ type ObjectsCopyCall struct { // object. Overrides the provided object metadata's bucket value, if // any.For information about how to URL encode object names to be path // safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). // - destinationObject: Name of the new object. Required when the object // metadata is not otherwise provided. Overrides the object metadata's // name value, if any. @@ -8640,7 +8641,8 @@ type ObjectsCopyCall struct { // object. // - sourceObject: Name of the source object. For information about how // to URL encode object names to be path safe, see Encoding URI Path -// Parts (http://cloud/storage/docs/request-endpoints#encoding). +// Parts +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectsService) Copy(sourceBucket string, sourceObject string, destinationBucket string, destinationObject string, object *Object) *ObjectsCopyCall { c := &ObjectsCopyCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.sourceBucket = sourceBucket @@ -8901,7 +8903,7 @@ func (c *ObjectsCopyCall) Do(opts ...googleapi.CallOption) (*Object, error) { // ], // "parameters": { // "destinationBucket": { - // "description": "Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -9012,7 +9014,7 @@ func (c *ObjectsCopyCall) Do(opts ...googleapi.CallOption) (*Object, error) { // "type": "string" // }, // "sourceObject": { - // "description": "Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -9057,7 +9059,7 @@ type ObjectsDeleteCall struct { // - bucket: Name of the bucket in which the object resides. // - object: Name of the object. For information about how to URL encode // object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectsService) Delete(bucket string, object string) *ObjectsDeleteCall { c := &ObjectsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.bucket = bucket @@ -9223,7 +9225,7 @@ func (c *ObjectsDeleteCall) Do(opts ...googleapi.CallOption) error { // "type": "string" // }, // "object": { - // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -9261,7 +9263,7 @@ type ObjectsGetCall struct { // - bucket: Name of the bucket in which the object resides. // - object: Name of the object. For information about how to URL encode // object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectsService) Get(bucket string, object string) *ObjectsGetCall { c := &ObjectsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.bucket = bucket @@ -9493,7 +9495,7 @@ func (c *ObjectsGetCall) Do(opts ...googleapi.CallOption) (*Object, error) { // "type": "string" // }, // "object": { - // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -9551,7 +9553,7 @@ type ObjectsGetIamPolicyCall struct { // - bucket: Name of the bucket in which the object resides. // - object: Name of the object. For information about how to URL encode // object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectsService) GetIamPolicy(bucket string, object string) *ObjectsGetIamPolicyCall { c := &ObjectsGetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.bucket = bucket @@ -9695,7 +9697,7 @@ func (c *ObjectsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, err // "type": "string" // }, // "object": { - // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -9808,7 +9810,7 @@ func (c *ObjectsInsertCall) KmsKeyName(kmsKeyName string) *ObjectsInsertCall { // when the object metadata is not otherwise provided. Overrides the // object metadata's name value, if any. For information about how to // URL encode object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (c *ObjectsInsertCall) Name(name string) *ObjectsInsertCall { c.urlParams_.Set("name", name) return c @@ -10118,7 +10120,7 @@ func (c *ObjectsInsertCall) Do(opts ...googleapi.CallOption) (*Object, error) { // "type": "string" // }, // "name": { - // "description": "Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "query", // "type": "string" // }, @@ -10529,7 +10531,7 @@ type ObjectsPatchCall struct { // - bucket: Name of the bucket in which the object resides. // - object: Name of the object. For information about how to URL encode // object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectsService) Patch(bucket string, object string, object2 *Object) *ObjectsPatchCall { c := &ObjectsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.bucket = bucket @@ -10768,7 +10770,7 @@ func (c *ObjectsPatchCall) Do(opts ...googleapi.CallOption) (*Object, error) { // "type": "string" // }, // "object": { - // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -10852,12 +10854,13 @@ type ObjectsRewriteCall struct { // metadata is not otherwise provided. Overrides the object metadata's // name value, if any. For information about how to URL encode object // names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). // - sourceBucket: Name of the bucket in which to find the source // object. // - sourceObject: Name of the source object. For information about how // to URL encode object names to be path safe, see Encoding URI Path -// Parts (http://cloud/storage/docs/request-endpoints#encoding). +// Parts +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectsService) Rewrite(sourceBucket string, sourceObject string, destinationBucket string, destinationObject string, object *Object) *ObjectsRewriteCall { c := &ObjectsRewriteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.sourceBucket = sourceBucket @@ -11153,7 +11156,7 @@ func (c *ObjectsRewriteCall) Do(opts ...googleapi.CallOption) (*RewriteResponse, // "type": "string" // }, // "destinationObject": { - // "description": "Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -11264,7 +11267,7 @@ func (c *ObjectsRewriteCall) Do(opts ...googleapi.CallOption) (*RewriteResponse, // "type": "string" // }, // "sourceObject": { - // "description": "Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -11308,7 +11311,7 @@ type ObjectsSetIamPolicyCall struct { // - bucket: Name of the bucket in which the object resides. // - object: Name of the object. For information about how to URL encode // object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectsService) SetIamPolicy(bucket string, object string, policy *Policy) *ObjectsSetIamPolicyCall { c := &ObjectsSetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.bucket = bucket @@ -11445,7 +11448,7 @@ func (c *ObjectsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, err // "type": "string" // }, // "object": { - // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -11490,7 +11493,7 @@ type ObjectsTestIamPermissionsCall struct { // - bucket: Name of the bucket in which the object resides. // - object: Name of the object. For information about how to URL encode // object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). // - permissions: Permissions to test. func (r *ObjectsService) TestIamPermissions(bucket string, object string, permissions []string) *ObjectsTestIamPermissionsCall { c := &ObjectsTestIamPermissionsCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -11637,7 +11640,7 @@ func (c *ObjectsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestI // "type": "string" // }, // "object": { - // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string" @@ -11687,7 +11690,7 @@ type ObjectsUpdateCall struct { // - bucket: Name of the bucket in which the object resides. // - object: Name of the object. For information about how to URL encode // object names to be path safe, see Encoding URI Path Parts -// (http://cloud/storage/docs/request-endpoints#encoding). +// (https://cloud.google.com/storage/docs/request-endpoints#encoding). func (r *ObjectsService) Update(bucket string, object string, object2 *Object) *ObjectsUpdateCall { c := &ObjectsUpdateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.bucket = bucket @@ -11926,7 +11929,7 @@ func (c *ObjectsUpdateCall) Do(opts ...googleapi.CallOption) (*Object, error) { // "type": "string" // }, // "object": { - // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](http://cloud/storage/docs/request-endpoints#encoding).", + // "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", // "location": "path", // "required": true, // "type": "string"