Synchronize new proto/yaml changes.

PiperOrigin-RevId: 236171487
This commit is contained in:
Google APIs 2019-02-28 12:15:28 -08:00 committed by Copybara-Service
parent f48dcc4e0d
commit aee52e90e8
21 changed files with 477 additions and 276 deletions

View File

@ -31,36 +31,33 @@ option java_outer_classname = "DataTransferProto";
option java_package = "com.google.cloud.bigquery.datatransfer.v1";
option php_namespace = "Google\\Cloud\\BigQuery\\DataTransfer\\V1";
// The Google BigQuery Data Transfer Service API enables BigQuery users to
// configure the transfer of their data from other Google Products into BigQuery.
// This service contains methods that are end user exposed. It backs up the
// frontend.
// configure the transfer of their data from other Google Products into
// BigQuery. This service contains methods that are end user exposed. It backs
// up the frontend.
service DataTransferService {
// Retrieves a supported data source and returns its settings,
// which can be used for UI rendering.
rpc GetDataSource(GetDataSourceRequest) returns (DataSource) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/dataSources/*}"
additional_bindings {
get: "/v1/{name=projects/*/dataSources/*}"
}
additional_bindings { get: "/v1/{name=projects/*/dataSources/*}" }
};
}
// Lists supported data sources and returns their settings,
// which can be used for UI rendering.
rpc ListDataSources(ListDataSourcesRequest) returns (ListDataSourcesResponse) {
rpc ListDataSources(ListDataSourcesRequest)
returns (ListDataSourcesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/dataSources"
additional_bindings {
get: "/v1/{parent=projects/*}/dataSources"
}
additional_bindings { get: "/v1/{parent=projects/*}/dataSources" }
};
}
// Creates a new data transfer configuration.
rpc CreateTransferConfig(CreateTransferConfigRequest) returns (TransferConfig) {
rpc CreateTransferConfig(CreateTransferConfigRequest)
returns (TransferConfig) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/transferConfigs"
body: "transfer_config"
@ -73,7 +70,8 @@ service DataTransferService {
// Updates a data transfer configuration.
// All fields must be set, even if they are not updated.
rpc UpdateTransferConfig(UpdateTransferConfigRequest) returns (TransferConfig) {
rpc UpdateTransferConfig(UpdateTransferConfigRequest)
returns (TransferConfig) {
option (google.api.http) = {
patch: "/v1/{transfer_config.name=projects/*/locations/*/transferConfigs/*}"
body: "transfer_config"
@ -86,12 +84,11 @@ service DataTransferService {
// Deletes a data transfer configuration,
// including any associated transfer runs and logs.
rpc DeleteTransferConfig(DeleteTransferConfigRequest) returns (google.protobuf.Empty) {
rpc DeleteTransferConfig(DeleteTransferConfigRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/transferConfigs/*}"
additional_bindings {
delete: "/v1/{name=projects/*/transferConfigs/*}"
}
additional_bindings { delete: "/v1/{name=projects/*/transferConfigs/*}" }
};
}
@ -99,19 +96,16 @@ service DataTransferService {
rpc GetTransferConfig(GetTransferConfigRequest) returns (TransferConfig) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/transferConfigs/*}"
additional_bindings {
get: "/v1/{name=projects/*/transferConfigs/*}"
}
additional_bindings { get: "/v1/{name=projects/*/transferConfigs/*}" }
};
}
// Returns information about all data transfers in the project.
rpc ListTransferConfigs(ListTransferConfigsRequest) returns (ListTransferConfigsResponse) {
rpc ListTransferConfigs(ListTransferConfigsRequest)
returns (ListTransferConfigsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/transferConfigs"
additional_bindings {
get: "/v1/{parent=projects/*}/transferConfigs"
}
additional_bindings { get: "/v1/{parent=projects/*}/transferConfigs" }
};
}
@ -119,7 +113,8 @@ service DataTransferService {
// For each date - or whatever granularity the data source supports - in the
// range, one transfer run is created.
// Note that runs are created per UTC time in the time range.
rpc ScheduleTransferRuns(ScheduleTransferRunsRequest) returns (ScheduleTransferRunsResponse) {
rpc ScheduleTransferRuns(ScheduleTransferRunsRequest)
returns (ScheduleTransferRunsResponse) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/transferConfigs/*}:scheduleRuns"
body: "*"
@ -141,7 +136,8 @@ service DataTransferService {
}
// Deletes the specified transfer run.
rpc DeleteTransferRun(DeleteTransferRunRequest) returns (google.protobuf.Empty) {
rpc DeleteTransferRun(DeleteTransferRunRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/transferConfigs/*/runs/*}"
additional_bindings {
@ -151,7 +147,8 @@ service DataTransferService {
}
// Returns information about running and completed jobs.
rpc ListTransferRuns(ListTransferRunsRequest) returns (ListTransferRunsResponse) {
rpc ListTransferRuns(ListTransferRunsRequest)
returns (ListTransferRunsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/transferConfigs/*}/runs"
additional_bindings {
@ -161,7 +158,8 @@ service DataTransferService {
}
// Returns user facing log messages for the data transfer run.
rpc ListTransferLogs(ListTransferLogsRequest) returns (ListTransferLogsResponse) {
rpc ListTransferLogs(ListTransferLogsRequest)
returns (ListTransferLogsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/transferConfigs/*/runs/*}/transferLogs"
additional_bindings {
@ -176,7 +174,8 @@ service DataTransferService {
// them on behalf of the end user. This API just checks whether we have OAuth
// token for the particular user, which is a pre-requisite before user can
// create a transfer config.
rpc CheckValidCreds(CheckValidCredsRequest) returns (CheckValidCredsResponse) {
rpc CheckValidCreds(CheckValidCredsRequest)
returns (CheckValidCredsResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/dataSources/*}:checkValidCreds"
body: "*"

View File

@ -29,7 +29,6 @@ option java_package = "com.google.cloud.bigquery.datatransfer.v1";
option objc_class_prefix = "GCBDT";
option php_namespace = "Google\\Cloud\\BigQuery\\DataTransfer\\V1";
// Represents a data transfer configuration. A transfer configuration
// contains all metadata needed to perform a data transfer. For example,
// `destination_dataset_id` specifies where data should be stored.

View File

@ -21,7 +21,6 @@ option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storag
option java_outer_classname = "AvroProto";
option java_package = "com.google.cloud.bigquery.storage.v1beta1";
// Avro schema.
message AvroSchema {
// Json serialized schema, as described at

View File

@ -20,7 +20,6 @@ package google.cloud.bigquery.storage.v1beta1;
option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta1;storage";
option java_package = "com.google.cloud.bigquery.storage.v1beta1";
// Options dictating how we read a table.
message TableReadOptions {
// Optional. Names of the fields in the table that should be read. If empty,

View File

@ -26,7 +26,6 @@ import "google/protobuf/timestamp.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta1;storage";
option java_package = "com.google.cloud.bigquery.storage.v1beta1";
// BigQuery storage API.
//
// The BigQuery storage API can be used to read data stored in BigQuery.
@ -43,8 +42,7 @@ service BigQueryStorage {
//
// Read sessions automatically expire 24 hours after they are created and do
// not require manual clean-up by the caller.
rpc CreateReadSession(CreateReadSessionRequest) returns (ReadSession) {
}
rpc CreateReadSession(CreateReadSessionRequest) returns (ReadSession) {}
// Reads rows from the table in the format prescribed by the read session.
// Each response contains one or more table rows, up to a maximum of 10 MiB
@ -55,14 +53,13 @@ service BigQueryStorage {
// estimated total number of rows in the read stream. This number is computed
// based on the total table size and the number of active streams in the read
// session, and may change as other streams continue to read data.
rpc ReadRows(ReadRowsRequest) returns (stream ReadRowsResponse) {
}
rpc ReadRows(ReadRowsRequest) returns (stream ReadRowsResponse) {}
// Creates additional streams for a ReadSession. This API can be used to
// dynamically adjust the parallelism of a batch processing task upwards by
// adding additional workers.
rpc BatchCreateReadSessionStreams(BatchCreateReadSessionStreamsRequest) returns (BatchCreateReadSessionStreamsResponse) {
}
rpc BatchCreateReadSessionStreams(BatchCreateReadSessionStreamsRequest)
returns (BatchCreateReadSessionStreamsResponse) {}
// Triggers the graceful termination of a single stream in a ReadSession. This
// API can be used to dynamically adjust the parallelism of a batch processing
@ -78,8 +75,7 @@ service BigQueryStorage {
// This method will return an error if there are no other live streams
// in the Session, or if SplitReadStream() has been called on the given
// Stream.
rpc FinalizeStream(FinalizeStreamRequest) returns (google.protobuf.Empty) {
}
rpc FinalizeStream(FinalizeStreamRequest) returns (google.protobuf.Empty) {}
// Splits a given read stream into two Streams. These streams are referred to
// as the primary and the residual of the split. The original stream can still
@ -94,8 +90,8 @@ service BigQueryStorage {
// completion.
//
// This method is guaranteed to be idempotent.
rpc SplitReadStream(SplitReadStreamRequest) returns (SplitReadStreamResponse) {
}
rpc SplitReadStream(SplitReadStreamRequest)
returns (SplitReadStreamResponse) {}
}
// Information about a single data stream within a read session.

View File

@ -23,7 +23,6 @@ option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storag
option java_outer_classname = "TableReferenceProto";
option java_package = "com.google.cloud.bigquery.storage.v1beta1";
// Table reference that includes just the 3 strings needed to identify a table.
message TableReference {
// The assigned project ID of the project.

View File

@ -23,44 +23,66 @@ option java_multiple_files = true;
option java_outer_classname = "LanguageServiceProto";
option java_package = "com.google.cloud.language.v1";
// Provides text analysis operations such as sentiment analysis and entity
// recognition.
service LanguageService {
// Analyzes the sentiment of the provided text.
rpc AnalyzeSentiment(AnalyzeSentimentRequest) returns (AnalyzeSentimentResponse) {
option (google.api.http) = { post: "/v1/documents:analyzeSentiment" body: "*" };
rpc AnalyzeSentiment(AnalyzeSentimentRequest)
returns (AnalyzeSentimentResponse) {
option (google.api.http) = {
post: "/v1/documents:analyzeSentiment"
body: "*"
};
}
// Finds named entities (currently proper names and common nouns) in the text
// along with entity types, salience, mentions for each entity, and
// other properties.
rpc AnalyzeEntities(AnalyzeEntitiesRequest) returns (AnalyzeEntitiesResponse) {
option (google.api.http) = { post: "/v1/documents:analyzeEntities" body: "*" };
rpc AnalyzeEntities(AnalyzeEntitiesRequest)
returns (AnalyzeEntitiesResponse) {
option (google.api.http) = {
post: "/v1/documents:analyzeEntities"
body: "*"
};
}
// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
// sentiment associated with each entity and its mentions.
rpc AnalyzeEntitySentiment(AnalyzeEntitySentimentRequest) returns (AnalyzeEntitySentimentResponse) {
option (google.api.http) = { post: "/v1/documents:analyzeEntitySentiment" body: "*" };
// Finds entities, similar to
// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
// in the text and analyzes sentiment associated with each entity and its
// mentions.
rpc AnalyzeEntitySentiment(AnalyzeEntitySentimentRequest)
returns (AnalyzeEntitySentimentResponse) {
option (google.api.http) = {
post: "/v1/documents:analyzeEntitySentiment"
body: "*"
};
}
// Analyzes the syntax of the text and provides sentence boundaries and
// tokenization along with part of speech tags, dependency trees, and other
// properties.
rpc AnalyzeSyntax(AnalyzeSyntaxRequest) returns (AnalyzeSyntaxResponse) {
option (google.api.http) = { post: "/v1/documents:analyzeSyntax" body: "*" };
option (google.api.http) = {
post: "/v1/documents:analyzeSyntax"
body: "*"
};
}
// Classifies a document into categories.
rpc ClassifyText(ClassifyTextRequest) returns (ClassifyTextResponse) {
option (google.api.http) = { post: "/v1/documents:classifyText" body: "*" };
option (google.api.http) = {
post: "/v1/documents:classifyText"
body: "*"
};
}
// A convenience method that provides all the features that analyzeSentiment,
// analyzeEntities, and analyzeSyntax provide in one call.
rpc AnnotateText(AnnotateTextRequest) returns (AnnotateTextResponse) {
option (google.api.http) = { post: "/v1/documents:annotateText" body: "*" };
option (google.api.http) = {
post: "/v1/documents:annotateText"
body: "*"
};
}
}
@ -114,8 +136,8 @@ message Sentence {
TextSpan text = 1;
// For calls to [AnalyzeSentiment][] or if
// [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_document_sentiment] is set to
// true, this field will contain the sentiment for the sentence.
// [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_document_sentiment]
// is set to true, this field will contain the sentiment for the sentence.
Sentiment sentiment = 2;
}
@ -175,9 +197,9 @@ message Entity {
repeated EntityMention mentions = 5;
// For calls to [AnalyzeEntitySentiment][] or if
// [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment] is set to
// true, this field will contain the aggregate sentiment expressed for this
// entity in the provided document.
// [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment]
// is set to true, this field will contain the aggregate sentiment expressed
// for this entity in the provided document.
Sentiment sentiment = 6;
}
@ -828,9 +850,9 @@ message EntityMention {
Type type = 2;
// For calls to [AnalyzeEntitySentiment][] or if
// [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment] is set to
// true, this field will contain the sentiment expressed for this mention of
// the entity in the provided document.
// [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment]
// is set to true, this field will contain the sentiment expressed for this
// mention of the entity in the provided document.
Sentiment sentiment = 3;
}
@ -840,7 +862,9 @@ message TextSpan {
string content = 1;
// The API calculates the beginning offset of the content in the original
// document according to the [EncodingType][google.cloud.language.v1.EncodingType] specified in the API request.
// document according to the
// [EncodingType][google.cloud.language.v1.EncodingType] specified in the API
// request.
int32 begin_offset = 2;
}
@ -870,7 +894,8 @@ message AnalyzeSentimentResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1.Document.language] field
// for more details.
string language = 2;
// The sentiment for all the sentences in the document.
@ -893,7 +918,8 @@ message AnalyzeEntitySentimentResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1.Document.language] field
// for more details.
string language = 2;
}
@ -913,7 +939,8 @@ message AnalyzeEntitiesResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1.Document.language] field
// for more details.
string language = 2;
}
@ -936,7 +963,8 @@ message AnalyzeSyntaxResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1.Document.language] field
// for more details.
string language = 3;
}
@ -1006,7 +1034,8 @@ message AnnotateTextResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1.Document.language] field
// for more details.
string language = 5;
// Categories identified in the input document.

View File

@ -23,33 +23,46 @@ option java_multiple_files = true;
option java_outer_classname = "LanguageServiceProto";
option java_package = "com.google.cloud.language.v1beta1";
// Provides text analysis operations such as sentiment analysis and entity
// recognition.
service LanguageService {
// Analyzes the sentiment of the provided text.
rpc AnalyzeSentiment(AnalyzeSentimentRequest) returns (AnalyzeSentimentResponse) {
option (google.api.http) = { post: "/v1beta1/documents:analyzeSentiment" body: "*" };
rpc AnalyzeSentiment(AnalyzeSentimentRequest)
returns (AnalyzeSentimentResponse) {
option (google.api.http) = {
post: "/v1beta1/documents:analyzeSentiment"
body: "*"
};
}
// Finds named entities (currently proper names and common nouns) in the text
// along with entity types, salience, mentions for each entity, and
// other properties.
rpc AnalyzeEntities(AnalyzeEntitiesRequest) returns (AnalyzeEntitiesResponse) {
option (google.api.http) = { post: "/v1beta1/documents:analyzeEntities" body: "*" };
rpc AnalyzeEntities(AnalyzeEntitiesRequest)
returns (AnalyzeEntitiesResponse) {
option (google.api.http) = {
post: "/v1beta1/documents:analyzeEntities"
body: "*"
};
}
// Analyzes the syntax of the text and provides sentence boundaries and
// tokenization along with part of speech tags, dependency trees, and other
// properties.
rpc AnalyzeSyntax(AnalyzeSyntaxRequest) returns (AnalyzeSyntaxResponse) {
option (google.api.http) = { post: "/v1beta1/documents:analyzeSyntax" body: "*" };
option (google.api.http) = {
post: "/v1beta1/documents:analyzeSyntax"
body: "*"
};
}
// A convenience method that provides all the features that analyzeSentiment,
// analyzeEntities, and analyzeSyntax provide in one call.
rpc AnnotateText(AnnotateTextRequest) returns (AnnotateTextResponse) {
option (google.api.http) = { post: "/v1beta1/documents:annotateText" body: "*" };
option (google.api.http) = {
post: "/v1beta1/documents:annotateText"
body: "*"
};
}
}
@ -89,11 +102,11 @@ message Document {
// The language of the document (if not specified, the language is
// automatically detected). Both ISO and BCP-47 language codes are
// accepted.<br>
// [Language Support](https://cloud.google.com/natural-language/docs/languages)
// lists currently supported languages for each API method.
// If the language (either specified by the caller or automatically detected)
// is not supported by the called API method, an `INVALID_ARGUMENT` error
// is returned.
// [Language
// Support](https://cloud.google.com/natural-language/docs/languages) lists
// currently supported languages for each API method. If the language (either
// specified by the caller or automatically detected) is not supported by the
// called API method, an `INVALID_ARGUMENT` error is returned.
string language = 4;
}
@ -103,8 +116,8 @@ message Sentence {
TextSpan text = 1;
// For calls to [AnalyzeSentiment][] or if
// [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1beta1.AnnotateTextRequest.Features.extract_document_sentiment] is set to
// true, this field will contain the sentiment for the sentence.
// [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1beta1.AnnotateTextRequest.Features.extract_document_sentiment]
// is set to true, this field will contain the sentiment for the sentence.
Sentiment sentiment = 2;
}
@ -800,7 +813,9 @@ message TextSpan {
string content = 1;
// The API calculates the beginning offset of the content in the original
// document according to the [EncodingType][google.cloud.language.v1beta1.EncodingType] specified in the API request.
// document according to the
// [EncodingType][google.cloud.language.v1beta1.EncodingType] specified in the
// API request.
int32 begin_offset = 2;
}
@ -821,7 +836,8 @@ message AnalyzeSentimentResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1beta1.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1beta1.Document.language]
// field for more details.
string language = 2;
// The sentiment for all the sentences in the document.
@ -844,7 +860,8 @@ message AnalyzeEntitiesResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1beta1.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1beta1.Document.language]
// field for more details.
string language = 2;
}
@ -867,7 +884,8 @@ message AnalyzeSyntaxResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1beta1.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1beta1.Document.language]
// field for more details.
string language = 3;
}
@ -919,7 +937,8 @@ message AnnotateTextResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1beta1.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1beta1.Document.language]
// field for more details.
string language = 5;
}

View File

@ -26,44 +26,66 @@ option java_multiple_files = true;
option java_outer_classname = "LanguageServiceProto";
option java_package = "com.google.cloud.language.v1beta2";
// Provides text analysis operations such as sentiment analysis and entity
// recognition.
service LanguageService {
// Analyzes the sentiment of the provided text.
rpc AnalyzeSentiment(AnalyzeSentimentRequest) returns (AnalyzeSentimentResponse) {
option (google.api.http) = { post: "/v1beta2/documents:analyzeSentiment" body: "*" };
rpc AnalyzeSentiment(AnalyzeSentimentRequest)
returns (AnalyzeSentimentResponse) {
option (google.api.http) = {
post: "/v1beta2/documents:analyzeSentiment"
body: "*"
};
}
// Finds named entities (currently proper names and common nouns) in the text
// along with entity types, salience, mentions for each entity, and
// other properties.
rpc AnalyzeEntities(AnalyzeEntitiesRequest) returns (AnalyzeEntitiesResponse) {
option (google.api.http) = { post: "/v1beta2/documents:analyzeEntities" body: "*" };
rpc AnalyzeEntities(AnalyzeEntitiesRequest)
returns (AnalyzeEntitiesResponse) {
option (google.api.http) = {
post: "/v1beta2/documents:analyzeEntities"
body: "*"
};
}
// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities] in the text and analyzes
// sentiment associated with each entity and its mentions.
rpc AnalyzeEntitySentiment(AnalyzeEntitySentimentRequest) returns (AnalyzeEntitySentimentResponse) {
option (google.api.http) = { post: "/v1beta2/documents:analyzeEntitySentiment" body: "*" };
// Finds entities, similar to
// [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities]
// in the text and analyzes sentiment associated with each entity and its
// mentions.
rpc AnalyzeEntitySentiment(AnalyzeEntitySentimentRequest)
returns (AnalyzeEntitySentimentResponse) {
option (google.api.http) = {
post: "/v1beta2/documents:analyzeEntitySentiment"
body: "*"
};
}
// Analyzes the syntax of the text and provides sentence boundaries and
// tokenization along with part of speech tags, dependency trees, and other
// properties.
rpc AnalyzeSyntax(AnalyzeSyntaxRequest) returns (AnalyzeSyntaxResponse) {
option (google.api.http) = { post: "/v1beta2/documents:analyzeSyntax" body: "*" };
option (google.api.http) = {
post: "/v1beta2/documents:analyzeSyntax"
body: "*"
};
}
// Classifies a document into categories.
rpc ClassifyText(ClassifyTextRequest) returns (ClassifyTextResponse) {
option (google.api.http) = { post: "/v1beta2/documents:classifyText" body: "*" };
option (google.api.http) = {
post: "/v1beta2/documents:classifyText"
body: "*"
};
}
// A convenience method that provides all syntax, sentiment, entity, and
// classification features in one call.
rpc AnnotateText(AnnotateTextRequest) returns (AnnotateTextResponse) {
option (google.api.http) = { post: "/v1beta2/documents:annotateText" body: "*" };
option (google.api.http) = {
post: "/v1beta2/documents:annotateText"
body: "*"
};
}
}
@ -117,8 +139,8 @@ message Sentence {
TextSpan text = 1;
// For calls to [AnalyzeSentiment][] or if
// [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_document_sentiment] is set to
// true, this field will contain the sentiment for the sentence.
// [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_document_sentiment]
// is set to true, this field will contain the sentiment for the sentence.
Sentiment sentiment = 2;
}
@ -178,9 +200,9 @@ message Entity {
repeated EntityMention mentions = 5;
// For calls to [AnalyzeEntitySentiment][] or if
// [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to
// true, this field will contain the aggregate sentiment expressed for this
// entity in the provided document.
// [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment]
// is set to true, this field will contain the aggregate sentiment expressed
// for this entity in the provided document.
Sentiment sentiment = 6;
}
@ -827,9 +849,9 @@ message EntityMention {
Type type = 2;
// For calls to [AnalyzeEntitySentiment][] or if
// [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to
// true, this field will contain the sentiment expressed for this mention of
// the entity in the provided document.
// [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment]
// is set to true, this field will contain the sentiment expressed for this
// mention of the entity in the provided document.
Sentiment sentiment = 3;
}
@ -839,7 +861,9 @@ message TextSpan {
string content = 1;
// The API calculates the beginning offset of the content in the original
// document according to the [EncodingType][google.cloud.language.v1beta2.EncodingType] specified in the API request.
// document according to the
// [EncodingType][google.cloud.language.v1beta2.EncodingType] specified in the
// API request.
int32 begin_offset = 2;
}
@ -870,7 +894,8 @@ message AnalyzeSentimentResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1beta2.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1beta2.Document.language]
// field for more details.
string language = 2;
// The sentiment for all the sentences in the document.
@ -893,7 +918,8 @@ message AnalyzeEntitySentimentResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1beta2.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1beta2.Document.language]
// field for more details.
string language = 2;
}
@ -913,7 +939,8 @@ message AnalyzeEntitiesResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1beta2.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1beta2.Document.language]
// field for more details.
string language = 2;
}
@ -936,7 +963,8 @@ message AnalyzeSyntaxResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1beta2.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1beta2.Document.language]
// field for more details.
string language = 3;
}
@ -1006,7 +1034,8 @@ message AnnotateTextResponse {
// The language of the text, which will be the same as the language specified
// in the request or, if not specified, the automatically-detected language.
// See [Document.language][google.cloud.language.v1beta2.Document.language] field for more details.
// See [Document.language][google.cloud.language.v1beta2.Document.language]
// field for more details.
string language = 5;
// Categories identified in the input document.

View File

@ -31,28 +31,36 @@ option java_package = "com.google.cloud.ml.api.v1";
// Proto file for the Google Cloud Machine Learning Engine.
// Describes the 'job service' to manage training and prediction jobs.
// Service to create and manage training and batch prediction jobs.
service JobService {
// Creates a training or a batch prediction job.
rpc CreateJob(CreateJobRequest) returns (Job) {
option (google.api.http) = { post: "/v1/{parent=projects/*}/jobs" body: "job" };
option (google.api.http) = {
post: "/v1/{parent=projects/*}/jobs"
body: "job"
};
}
// Lists the jobs in the project.
rpc ListJobs(ListJobsRequest) returns (ListJobsResponse) {
option (google.api.http) = { get: "/v1/{parent=projects/*}/jobs" };
option (google.api.http) = {
get: "/v1/{parent=projects/*}/jobs"
};
}
// Describes a job.
rpc GetJob(GetJobRequest) returns (Job) {
option (google.api.http) = { get: "/v1/{name=projects/*/jobs/*}" };
option (google.api.http) = {
get: "/v1/{name=projects/*/jobs/*}"
};
}
// Cancels a running job.
rpc CancelJob(CancelJobRequest) returns (google.protobuf.Empty) {
option (google.api.http) = { post: "/v1/{name=projects/*/jobs/*}:cancel" body: "*" };
option (google.api.http) = {
post: "/v1/{name=projects/*/jobs/*}:cancel"
body: "*"
};
}
}

View File

@ -32,8 +32,6 @@ option java_package = "com.google.cloud.ml.api.v1";
// Describes the 'models service' to work with the 'model' and 'version'
// resources.
// Provides methods that create and manage machine learning models and their
// versions.
//
@ -67,7 +65,10 @@ service ModelService {
// the model. Add versions by calling
// [projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create).
rpc CreateModel(CreateModelRequest) returns (Model) {
option (google.api.http) = { post: "/v1/{parent=projects/*}/models" body: "model" };
option (google.api.http) = {
post: "/v1/{parent=projects/*}/models"
body: "model"
};
}
// Lists the models in a project.
@ -75,14 +76,18 @@ service ModelService {
// Each project can contain multiple models, and each model can have multiple
// versions.
rpc ListModels(ListModelsRequest) returns (ListModelsResponse) {
option (google.api.http) = { get: "/v1/{parent=projects/*}/models" };
option (google.api.http) = {
get: "/v1/{parent=projects/*}/models"
};
}
// Gets information about a model, including its name, the description (if
// set), and the default version (if at least one version of the model has
// been deployed).
rpc GetModel(GetModelRequest) returns (Model) {
option (google.api.http) = { get: "/v1/{name=projects/*/models/*}" };
option (google.api.http) = {
get: "/v1/{name=projects/*/models/*}"
};
}
// Deletes a model.
@ -91,7 +96,9 @@ service ModelService {
// versions by calling
// [projects.models.versions.delete](/ml/reference/rest/v1/projects.models.versions/delete).
rpc DeleteModel(DeleteModelRequest) returns (google.longrunning.Operation) {
option (google.api.http) = { delete: "/v1/{name=projects/*/models/*}" };
option (google.api.http) = {
delete: "/v1/{name=projects/*/models/*}"
};
}
// Creates a new version of a model from a trained TensorFlow model.
@ -102,8 +109,12 @@ service ModelService {
// versions, the default version does not automatically change. If you want a
// new version to be the default, you must call
// [projects.models.versions.setDefault](/ml/reference/rest/v1/projects.models.versions/setDefault).
rpc CreateVersion(CreateVersionRequest) returns (google.longrunning.Operation) {
option (google.api.http) = { post: "/v1/{parent=projects/*/models/*}/versions" body: "version" };
rpc CreateVersion(CreateVersionRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/models/*}/versions"
body: "version"
};
}
// Gets basic information about all the versions of a model.
@ -112,7 +123,9 @@ service ModelService {
// only a limited number of results at a time, you can request that the list
// be retrieved in batches (called pages):
rpc ListVersions(ListVersionsRequest) returns (ListVersionsResponse) {
option (google.api.http) = { get: "/v1/{parent=projects/*/models/*}/versions" };
option (google.api.http) = {
get: "/v1/{parent=projects/*/models/*}/versions"
};
}
// Gets information about a model version.
@ -122,7 +135,9 @@ service ModelService {
// to get the same information that this method returns for all of the
// versions of a model.
rpc GetVersion(GetVersionRequest) returns (Version) {
option (google.api.http) = { get: "/v1/{name=projects/*/models/*/versions/*}" };
option (google.api.http) = {
get: "/v1/{name=projects/*/models/*/versions/*}"
};
}
// Deletes a model version.
@ -132,8 +147,11 @@ service ModelService {
//
// Note: You cannot delete the version that is set as the default version
// of the model unless it is the only remaining version.
rpc DeleteVersion(DeleteVersionRequest) returns (google.longrunning.Operation) {
option (google.api.http) = { delete: "/v1/{name=projects/*/models/*/versions/*}" };
rpc DeleteVersion(DeleteVersionRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/models/*/versions/*}"
};
}
// Designates a version to be the default for the model.
@ -145,7 +163,10 @@ service ModelService {
// default. You must make any subsequent changes to the default version
// setting manually using this method.
rpc SetDefaultVersion(SetDefaultVersionRequest) returns (Version) {
option (google.api.http) = { post: "/v1/{name=projects/*/models/*/versions/*}:setDefault" body: "*" };
option (google.api.http) = {
post: "/v1/{name=projects/*/models/*/versions/*}:setDefault"
body: "*"
};
}
}

View File

@ -30,8 +30,6 @@ option java_package = "com.google.cloud.ml.api.v1";
// Proto file for the Google Cloud Machine Learning Engine.
// Describes the metadata for longrunning operations.
// Represents the metadata of the long-running operation.
message OperationMetadata {
// The operation type.

View File

@ -29,8 +29,6 @@ option java_package = "com.google.cloud.ml.api.v1";
// Proto file for the Google Cloud Machine Learning Engine.
// Describes the online prediction service.
// The Prediction API, which serves predictions for models managed by
// ModelService.
service OnlinePredictionService {
@ -38,7 +36,10 @@ service OnlinePredictionService {
//
// **** REMOVE FROM GENERATED DOCUMENTATION
rpc Predict(PredictRequest) returns (google.api.HttpBody) {
option (google.api.http) = { post: "/v1/{name=projects/**}:predict" body: "*" };
option (google.api.http) = {
post: "/v1/{name=projects/**}:predict"
body: "*"
};
}
}

View File

@ -28,8 +28,6 @@ option java_package = "com.google.cloud.ml.api.v1";
// Proto file for the Google Cloud Machine Learning Engine.
// Describes the project management service.
// Allows retrieving project related information.
service ProjectManagementService {
// Get the service account information associated with your project. You need
@ -37,7 +35,9 @@ service ProjectManagementService {
// the Google Cloud Storage location where you put your model training code
// for training the model with Google Cloud Machine Learning.
rpc GetConfig(GetConfigRequest) returns (GetConfigResponse) {
option (google.api.http) = { get: "/v1/{name=projects/*}:getConfig" };
option (google.api.http) = {
get: "/v1/{name=projects/*}:getConfig"
};
}
}

View File

@ -24,7 +24,6 @@ option java_outer_classname = "OsLoginProto";
option java_package = "com.google.cloud.oslogin.common";
option php_namespace = "Google\\Cloud\\OsLogin\\Common";
// The POSIX account information associated with a Google account.
message PosixAccount {
// Only one POSIX account can be marked as primary.

View File

@ -28,44 +28,62 @@ option java_outer_classname = "OsLoginProto";
option java_package = "com.google.cloud.oslogin.v1";
option php_namespace = "Google\\Cloud\\OsLogin\\V1";
// Cloud OS Login API
//
// The Cloud OS Login API allows you to manage users and their associated SSH
// public keys for logging into virtual machines on Google Cloud Platform.
service OsLoginService {
// Deletes a POSIX account.
rpc DeletePosixAccount(DeletePosixAccountRequest) returns (google.protobuf.Empty) {
option (google.api.http) = { delete: "/v1/{name=users/*/projects/*}" };
rpc DeletePosixAccount(DeletePosixAccountRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=users/*/projects/*}"
};
}
// Deletes an SSH public key.
rpc DeleteSshPublicKey(DeleteSshPublicKeyRequest) returns (google.protobuf.Empty) {
option (google.api.http) = { delete: "/v1/{name=users/*/sshPublicKeys/*}" };
rpc DeleteSshPublicKey(DeleteSshPublicKeyRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=users/*/sshPublicKeys/*}"
};
}
// Retrieves the profile information used for logging in to a virtual machine
// on Google Compute Engine.
rpc GetLoginProfile(GetLoginProfileRequest) returns (LoginProfile) {
option (google.api.http) = { get: "/v1/{name=users/*}/loginProfile" };
option (google.api.http) = {
get: "/v1/{name=users/*}/loginProfile"
};
}
// Retrieves an SSH public key.
rpc GetSshPublicKey(GetSshPublicKeyRequest) returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = { get: "/v1/{name=users/*/sshPublicKeys/*}" };
rpc GetSshPublicKey(GetSshPublicKeyRequest)
returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = {
get: "/v1/{name=users/*/sshPublicKeys/*}"
};
}
// Adds an SSH public key and returns the profile information. Default POSIX
// account information is set when no username and UID exist as part of the
// login profile.
rpc ImportSshPublicKey(ImportSshPublicKeyRequest) returns (ImportSshPublicKeyResponse) {
option (google.api.http) = { post: "/v1/{parent=users/*}:importSshPublicKey" body: "ssh_public_key" };
rpc ImportSshPublicKey(ImportSshPublicKeyRequest)
returns (ImportSshPublicKeyResponse) {
option (google.api.http) = {
post: "/v1/{parent=users/*}:importSshPublicKey"
body: "ssh_public_key"
};
}
// Updates an SSH public key and returns the profile information. This method
// supports patch semantics.
rpc UpdateSshPublicKey(UpdateSshPublicKeyRequest) returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = { patch: "/v1/{name=users/*/sshPublicKeys/*}" body: "ssh_public_key" };
rpc UpdateSshPublicKey(UpdateSshPublicKeyRequest)
returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = {
patch: "/v1/{name=users/*/sshPublicKeys/*}"
body: "ssh_public_key"
};
}
}

View File

@ -28,44 +28,62 @@ option java_outer_classname = "OsLoginProto";
option java_package = "com.google.cloud.oslogin.v1alpha";
option php_namespace = "Google\\Cloud\\OsLogin\\V1alpha";
// Cloud OS Login API
//
// The Cloud OS Login API allows you to manage users and their associated SSH
// public keys for logging into virtual machines on Google Cloud Platform.
service OsLoginService {
// Deletes a POSIX account.
rpc DeletePosixAccount(DeletePosixAccountRequest) returns (google.protobuf.Empty) {
option (google.api.http) = { delete: "/v1alpha/{name=users/*/projects/*}" };
rpc DeletePosixAccount(DeletePosixAccountRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=users/*/projects/*}"
};
}
// Deletes an SSH public key.
rpc DeleteSshPublicKey(DeleteSshPublicKeyRequest) returns (google.protobuf.Empty) {
option (google.api.http) = { delete: "/v1alpha/{name=users/*/sshPublicKeys/*}" };
rpc DeleteSshPublicKey(DeleteSshPublicKeyRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=users/*/sshPublicKeys/*}"
};
}
// Retrieves the profile information used for logging in to a virtual machine
// on Google Compute Engine.
rpc GetLoginProfile(GetLoginProfileRequest) returns (LoginProfile) {
option (google.api.http) = { get: "/v1alpha/{name=users/*}/loginProfile" };
option (google.api.http) = {
get: "/v1alpha/{name=users/*}/loginProfile"
};
}
// Retrieves an SSH public key.
rpc GetSshPublicKey(GetSshPublicKeyRequest) returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = { get: "/v1alpha/{name=users/*/sshPublicKeys/*}" };
rpc GetSshPublicKey(GetSshPublicKeyRequest)
returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = {
get: "/v1alpha/{name=users/*/sshPublicKeys/*}"
};
}
// Adds an SSH public key and returns the profile information. Default POSIX
// account information is set when no username and UID exist as part of the
// login profile.
rpc ImportSshPublicKey(ImportSshPublicKeyRequest) returns (ImportSshPublicKeyResponse) {
option (google.api.http) = { post: "/v1alpha/{parent=users/*}:importSshPublicKey" body: "ssh_public_key" };
rpc ImportSshPublicKey(ImportSshPublicKeyRequest)
returns (ImportSshPublicKeyResponse) {
option (google.api.http) = {
post: "/v1alpha/{parent=users/*}:importSshPublicKey"
body: "ssh_public_key"
};
}
// Updates an SSH public key and returns the profile information. This method
// supports patch semantics.
rpc UpdateSshPublicKey(UpdateSshPublicKeyRequest) returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = { patch: "/v1alpha/{name=users/*/sshPublicKeys/*}" body: "ssh_public_key" };
rpc UpdateSshPublicKey(UpdateSshPublicKeyRequest)
returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = {
patch: "/v1alpha/{name=users/*/sshPublicKeys/*}"
body: "ssh_public_key"
};
}
}

View File

@ -28,44 +28,62 @@ option java_outer_classname = "OsLoginProto";
option java_package = "com.google.cloud.oslogin.v1beta";
option php_namespace = "Google\\Cloud\\OsLogin\\V1beta";
// Cloud OS Login API
//
// The Cloud OS Login API allows you to manage users and their associated SSH
// public keys for logging into virtual machines on Google Cloud Platform.
service OsLoginService {
// Deletes a POSIX account.
rpc DeletePosixAccount(DeletePosixAccountRequest) returns (google.protobuf.Empty) {
option (google.api.http) = { delete: "/v1beta/{name=users/*/projects/*}" };
rpc DeletePosixAccount(DeletePosixAccountRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1beta/{name=users/*/projects/*}"
};
}
// Deletes an SSH public key.
rpc DeleteSshPublicKey(DeleteSshPublicKeyRequest) returns (google.protobuf.Empty) {
option (google.api.http) = { delete: "/v1beta/{name=users/*/sshPublicKeys/*}" };
rpc DeleteSshPublicKey(DeleteSshPublicKeyRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1beta/{name=users/*/sshPublicKeys/*}"
};
}
// Retrieves the profile information used for logging in to a virtual machine
// on Google Compute Engine.
rpc GetLoginProfile(GetLoginProfileRequest) returns (LoginProfile) {
option (google.api.http) = { get: "/v1beta/{name=users/*}/loginProfile" };
option (google.api.http) = {
get: "/v1beta/{name=users/*}/loginProfile"
};
}
// Retrieves an SSH public key.
rpc GetSshPublicKey(GetSshPublicKeyRequest) returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = { get: "/v1beta/{name=users/*/sshPublicKeys/*}" };
rpc GetSshPublicKey(GetSshPublicKeyRequest)
returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = {
get: "/v1beta/{name=users/*/sshPublicKeys/*}"
};
}
// Adds an SSH public key and returns the profile information. Default POSIX
// account information is set when no username and UID exist as part of the
// login profile.
rpc ImportSshPublicKey(ImportSshPublicKeyRequest) returns (ImportSshPublicKeyResponse) {
option (google.api.http) = { post: "/v1beta/{parent=users/*}:importSshPublicKey" body: "ssh_public_key" };
rpc ImportSshPublicKey(ImportSshPublicKeyRequest)
returns (ImportSshPublicKeyResponse) {
option (google.api.http) = {
post: "/v1beta/{parent=users/*}:importSshPublicKey"
body: "ssh_public_key"
};
}
// Updates an SSH public key and returns the profile information. This method
// supports patch semantics.
rpc UpdateSshPublicKey(UpdateSshPublicKeyRequest) returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = { patch: "/v1beta/{name=users/*/sshPublicKeys/*}" body: "ssh_public_key" };
rpc UpdateSshPublicKey(UpdateSshPublicKeyRequest)
returns (google.cloud.oslogin.common.SshPublicKey) {
option (google.api.http) = {
patch: "/v1beta/{name=users/*/sshPublicKeys/*}"
body: "ssh_public_key"
};
}
}

View File

@ -28,7 +28,6 @@ option java_outer_classname = "SchedulerProto";
option java_package = "com.google.cloud.scheduler.v1beta1";
option objc_class_prefix = "SCHEDULER";
// The Cloud Scheduler API allows external entities to reliably
// schedule asynchronous jobs.
service CloudScheduler {
@ -56,13 +55,14 @@ service CloudScheduler {
// Updates a job.
//
// If successful, the updated [Job][google.cloud.scheduler.v1beta1.Job] is returned. If the job does
// not exist, `NOT_FOUND` is returned.
// If successful, the updated [Job][google.cloud.scheduler.v1beta1.Job] is
// returned. If the job does not exist, `NOT_FOUND` is returned.
//
// If UpdateJob does not successfully return, it is possible for the
// job to be in an [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1beta1.Job.State.UPDATE_FAILED] state. A job in this state may
// not be executed. If this happens, retry the UpdateJob request
// until a successful response is received.
// job to be in an
// [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1beta1.Job.State.UPDATE_FAILED]
// state. A job in this state may not be executed. If this happens, retry the
// UpdateJob request until a successful response is received.
rpc UpdateJob(UpdateJobRequest) returns (Job) {
option (google.api.http) = {
patch: "/v1beta1/{job.name=projects/*/locations/*/jobs/*}"
@ -80,10 +80,14 @@ service CloudScheduler {
// Pauses a job.
//
// If a job is paused then the system will stop executing the job
// until it is re-enabled via [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. The
// state of the job is stored in [state][google.cloud.scheduler.v1beta1.Job.state]; if paused it
// will be set to [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. A job must be in [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED]
// to be paused.
// until it is re-enabled via
// [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. The
// state of the job is stored in
// [state][google.cloud.scheduler.v1beta1.Job.state]; if paused it will be set
// to [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. A
// job must be in
// [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED] to be
// paused.
rpc PauseJob(PauseJobRequest) returns (Job) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/jobs/*}:pause"
@ -93,10 +97,15 @@ service CloudScheduler {
// Resume a job.
//
// This method reenables a job after it has been [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. The
// state of a job is stored in [Job.state][google.cloud.scheduler.v1beta1.Job.state]; after calling this method it
// will be set to [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED]. A job must be in
// [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED] to be resumed.
// This method reenables a job after it has been
// [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. The
// state of a job is stored in
// [Job.state][google.cloud.scheduler.v1beta1.Job.state]; after calling this
// method it will be set to
// [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED]. A
// job must be in
// [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED] to be
// resumed.
rpc ResumeJob(ResumeJobRequest) returns (Job) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/jobs/*}:resume"
@ -116,7 +125,8 @@ service CloudScheduler {
}
}
// Request message for listing jobs using [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs].
// Request message for listing jobs using
// [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs].
message ListJobsRequest {
// Required.
//
@ -135,29 +145,35 @@ message ListJobsRequest {
// A token identifying a page of results the server will return. To
// request the first page results, page_token must be empty. To
// request the next page of results, page_token must be the value of
// [next_page_token][google.cloud.scheduler.v1beta1.ListJobsResponse.next_page_token] returned from
// the previous call to [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. It is an error to
// switch the value of [filter][google.cloud.scheduler.v1beta1.ListJobsRequest.filter] or
// [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while iterating through pages.
// [next_page_token][google.cloud.scheduler.v1beta1.ListJobsResponse.next_page_token]
// returned from the previous call to
// [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. It is
// an error to switch the value of
// [filter][google.cloud.scheduler.v1beta1.ListJobsRequest.filter] or
// [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while
// iterating through pages.
string page_token = 6;
}
// Response message for listing jobs using [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs].
// Response message for listing jobs using
// [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs].
message ListJobsResponse {
// The list of jobs.
repeated Job jobs = 1;
// A token to retrieve next page of results. Pass this value in the
// [page_token][google.cloud.scheduler.v1beta1.ListJobsRequest.page_token] field in the subsequent call to
// [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs] to retrieve the next page of results.
// If this is empty it indicates that there are no more results
// through which to paginate.
// [page_token][google.cloud.scheduler.v1beta1.ListJobsRequest.page_token]
// field in the subsequent call to
// [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs] to
// retrieve the next page of results. If this is empty it indicates that there
// are no more results through which to paginate.
//
// The page token is valid for only 2 hours.
string next_page_token = 2;
}
// Request message for [GetJob][google.cloud.scheduler.v1beta1.CloudScheduler.GetJob].
// Request message for
// [GetJob][google.cloud.scheduler.v1beta1.CloudScheduler.GetJob].
message GetJobRequest {
// Required.
//
@ -166,7 +182,8 @@ message GetJobRequest {
string name = 1;
}
// Request message for [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob].
// Request message for
// [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob].
message CreateJobRequest {
// Required.
//
@ -177,18 +194,21 @@ message CreateJobRequest {
// Required.
//
// The job to add. The user can optionally specify a name for the
// job in [name][google.cloud.scheduler.v1beta1.Job.name]. [name][google.cloud.scheduler.v1beta1.Job.name] cannot be the same as an
// job in [name][google.cloud.scheduler.v1beta1.Job.name].
// [name][google.cloud.scheduler.v1beta1.Job.name] cannot be the same as an
// existing job. If a name is not specified then the system will
// generate a random unique name that will be returned
// ([name][google.cloud.scheduler.v1beta1.Job.name]) in the response.
Job job = 2;
}
// Request message for [UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob].
// Request message for
// [UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob].
message UpdateJobRequest {
// Required.
//
// The new job properties. [name][google.cloud.scheduler.v1beta1.Job.name] must be specified.
// The new job properties. [name][google.cloud.scheduler.v1beta1.Job.name]
// must be specified.
//
// Output only fields cannot be modified using UpdateJob.
// Any value specified for an output only field will be ignored.
@ -208,7 +228,8 @@ message DeleteJobRequest {
string name = 1;
}
// Request message for [PauseJob][google.cloud.scheduler.v1beta1.CloudScheduler.PauseJob].
// Request message for
// [PauseJob][google.cloud.scheduler.v1beta1.CloudScheduler.PauseJob].
message PauseJobRequest {
// Required.
//
@ -217,7 +238,8 @@ message PauseJobRequest {
string name = 1;
}
// Request message for [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob].
// Request message for
// [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob].
message ResumeJobRequest {
// Required.
//

View File

@ -28,7 +28,6 @@ option java_multiple_files = true;
option java_outer_classname = "JobProto";
option java_package = "com.google.cloud.scheduler.v1beta1";
// Configuration for a job.
// The maximum allowed size for a job is 100KB.
message Job {
@ -49,9 +48,11 @@ message Job {
// cannot directly set a job to be disabled.
DISABLED = 3;
// The job state resulting from a failed [CloudScheduler.UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob]
// The job state resulting from a failed
// [CloudScheduler.UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob]
// operation. To recover a job from this state, retry
// [CloudScheduler.UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob] until a successful response is received.
// [CloudScheduler.UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob]
// until a successful response is received.
UPDATE_FAILED = 4;
}
@ -61,7 +62,8 @@ message Job {
// * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
// hyphens (-), colons (:), or periods (.).
// For more information, see
// [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
// [Identifying
// projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
// * `LOCATION_ID` is the canonical ID for the job's location.
// The list of available locations can be obtained by calling
// [ListLocations][google.cloud.location.Locations.ListLocations].
@ -101,20 +103,23 @@ message Job {
// A scheduled start time will be delayed if the previous
// execution has not ended when its scheduled time occurs.
//
// If [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] > 0 and a job attempt fails,
// the job will be tried a total of [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count]
// If [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] >
// 0 and a job attempt fails, the job will be tried a total of
// [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count]
// times, with exponential backoff, until the next scheduled start
// time.
//
// The schedule can be either of the following types:
//
// * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)
// * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)
// * English-like
// [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)
string schedule = 20;
// Specifies the time zone to be used in interpreting
// [schedule][google.cloud.scheduler.v1beta1.Job.schedule]. The value of this field must be a time
// zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).
// [schedule][google.cloud.scheduler.v1beta1.Job.schedule]. The value of this
// field must be a time zone name from the [tz
// database](http://en.wikipedia.org/wiki/Tz_database).
//
// Note that some time zones include a provision for
// daylight savings time. The rules for daylight saving time are
@ -148,7 +153,8 @@ message Job {
//
// By default, if a job does not complete successfully (meaning that
// an acknowledgement is not received from the handler, then it will be retried
// with exponential backoff according to the settings in [RetryConfig][google.cloud.scheduler.v1beta1.RetryConfig].
// with exponential backoff according to the settings in
// [RetryConfig][google.cloud.scheduler.v1beta1.RetryConfig].
message RetryConfig {
// The number of attempts that the system will make to run a job using the
// exponential backoff procedure described by
@ -170,8 +176,8 @@ message RetryConfig {
// The time limit for retrying a failed job, measured from time when an
// execution was first attempted. If specified with
// [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count], the job will be retried until both limits are
// reached.
// [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count], the
// job will be retried until both limits are reached.
//
// The default value for max_retry_duration is zero, which means retry
// duration is unlimited.
@ -192,20 +198,25 @@ message RetryConfig {
// The time between retries will double `max_doublings` times.
//
// A job's retry interval starts at
// [min_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.min_backoff_duration], then doubles
// `max_doublings` times, then increases linearly, and finally
// [min_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.min_backoff_duration],
// then doubles `max_doublings` times, then increases linearly, and finally
// retries retries at intervals of
// [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration] up to
// [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] times.
// [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration]
// up to [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count]
// times.
//
// For example, if [min_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.min_backoff_duration] is
// 10s, [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration] is 300s, and
// `max_doublings` is 3, then the a job will first be retried in 10s. The
// retry interval will double three times, and then increase linearly by
// 2^3 * 10s. Finally, the job will retry at intervals of
// [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration] until the job has
// been attempted [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] times. Thus, the
// requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
// For example, if
// [min_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.min_backoff_duration]
// is 10s,
// [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration]
// is 300s, and `max_doublings` is 3, then the a job will first be retried in
// 10s. The retry interval will double three times, and then increase linearly
// by 2^3 * 10s. Finally, the job will retry at intervals of
// [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration]
// until the job has been attempted
// [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count]
// times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s,
// 300s, 300s, ....
//
// The default value of this field is 5.
int32 max_doublings = 5;

View File

@ -25,10 +25,10 @@ option java_multiple_files = true;
option java_outer_classname = "TargetProto";
option java_package = "com.google.cloud.scheduler.v1beta1";
// Http target. The job will be pushed to the job handler by means of
// an HTTP request via an [http_method][google.cloud.scheduler.v1beta1.HttpTarget.http_method] such as HTTP
// POST, HTTP GET, etc. The job is acknowledged by means of an HTTP
// an HTTP request via an
// [http_method][google.cloud.scheduler.v1beta1.HttpTarget.http_method] such as
// HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP
// response code in the range [200 - 299]. A failure to receive a response
// constitutes a failed execution. For a redirected request, the response
// returned by the redirected request is considered.
@ -70,14 +70,14 @@ message HttpTarget {
}
// App Engine target. The job will be pushed to a job handler by means
// of an HTTP request via an [http_method][google.cloud.scheduler.v1beta1.AppEngineHttpTarget.http_method] such
// as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an
// HTTP response code in the range [200 - 299]. Error 503 is
// considered an App Engine system error instead of an application
// error. Requests returning error 503 will be retried regardless of
// retry configuration and not counted against retry counts. Any other
// response code, or a failure to receive a response before the
// deadline, constitutes a failed attempt.
// of an HTTP request via an
// [http_method][google.cloud.scheduler.v1beta1.AppEngineHttpTarget.http_method]
// such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP
// response code in the range [200 - 299]. Error 503 is considered an App Engine
// system error instead of an application error. Requests returning error 503
// will be retried regardless of retry configuration and not counted against
// retry counts. Any other response code, or a failure to receive a response
// before the deadline, constitutes a failed attempt.
message AppEngineHttpTarget {
// The HTTP method to use for the request. PATCH and OPTIONS are not
// permitted.
@ -107,8 +107,9 @@ message AppEngineHttpTarget {
// `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
// modified `User-Agent`.
//
// If the job has an [body][google.cloud.scheduler.v1beta1.AppEngineHttpTarget.body], Cloud Scheduler sets the
// following headers:
// If the job has an
// [body][google.cloud.scheduler.v1beta1.AppEngineHttpTarget.body], Cloud
// Scheduler sets the following headers:
//
// * `Content-Type`: By default, the `Content-Type` header is set to
// `"application/octet-stream"`. The default can be overridden by explictly
@ -122,18 +123,21 @@ message AppEngineHttpTarget {
//
// * `X-Google-*`: For Google internal use only.
// * `X-AppEngine-*`: For Google internal use only. See
// [Reading request headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
// [Reading request
// headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
//
// In addition, some App Engine headers, which contain
// job-specific information, are also be sent to the job handler; see
// [request headers](https://cloud.google.com/appengine/docs/standard/python/config/cron#securing_urls_for_cron).
// [request
// headers](https://cloud.google.com/appengine/docs/standard/python/config/cron#securing_urls_for_cron).
map<string, string> headers = 4;
// Body.
//
// HTTP request body. A request body is allowed only if the HTTP method is
// POST or PUT. It will result in invalid argument error to set a body on a
// job with an incompatible [HttpMethod][google.cloud.scheduler.v1beta1.HttpMethod].
// job with an incompatible
// [HttpMethod][google.cloud.scheduler.v1beta1.HttpMethod].
bytes body = 5;
}
@ -167,10 +171,14 @@ message PubsubTarget {
// App Engine Routing.
//
// For more information about services, versions, and instances see
// [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
// [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
// [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and
// [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
// [An Overview of App
// Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
// [Microservices Architecture on Google App
// Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
// [App Engine Standard request
// routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
// and [App Engine Flex request
// routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
message AppEngineRouting {
// App service.
//
@ -190,10 +198,13 @@ message AppEngineRouting {
// the job is attempted.
//
// Requests can only be sent to a specific instance if
// [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
// [manual scaling is used in App Engine
// Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
// App Engine Flex does not support instances. For more information, see
// [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and
// [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
// [App Engine Standard request
// routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
// and [App Engine Flex request
// routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
string instance = 3;
// Output only. The host that the job is sent to.
@ -217,43 +228,51 @@ message AppEngineRouting {
// example <app-id>.appspot.com, which is associated with the
// job's project ID.
//
// * `service =` [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service]
// * `service =`
// [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service]
//
// * `version =` [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version]
// * `version =`
// [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version]
//
// * `version_dot_service =`
// [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] `+ '.' +`
// [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service]
// [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] `+ '.'
// +` [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service]
//
// * `instance =` [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance]
// * `instance =`
// [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance]
//
// * `instance_dot_service =`
// [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+ '.' +`
// [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service]
// [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+
// '.' +` [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service]
//
// * `instance_dot_version =`
// [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+ '.' +`
// [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version]
// [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+
// '.' +` [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version]
//
// * `instance_dot_version_dot_service =`
// [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+ '.' +`
// [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] `+ '.' +`
// [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] `+
// '.' +` [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version]
// `+ '.' +`
// [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service]
//
//
// If [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] is empty, then the job will be sent
// to the service which is the default service when the job is attempted.
// If [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service] is
// empty, then the job will be sent to the service which is the default
// service when the job is attempted.
//
// If [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] is empty, then the job will be sent
// to the version which is the default version when the job is attempted.
// If [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version] is
// empty, then the job will be sent to the version which is the default
// version when the job is attempted.
//
// If [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] is empty, then the job will be
// sent to an instance which is available when the job is attempted.
// If [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] is
// empty, then the job will be sent to an instance which is available when the
// job is attempted.
//
// If [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service],
// [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version], or
// [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] is invalid, then the job will be sent
// to the default version of the default service when the job is attempted.
// [instance][google.cloud.scheduler.v1beta1.AppEngineRouting.instance] is
// invalid, then the job will be sent to the default version of the default
// service when the job is attempted.
string host = 4;
}