Skip to content

Commit

Permalink
stackdriver: update gRPC schemas (#992)
Browse files Browse the repository at this point in the history
  • Loading branch information
@djc
djc authored Mar 14, 2023
1 parent 62450b9 commit 592e77a
Show file tree
Hide file tree
Showing 9 changed files with 792 additions and 181 deletions.
250 changes: 250 additions & 0 deletions opentelemetry-stackdriver/proto/google/api/client.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ syntax = "proto3";

package google.api;

import "google/api/launch_stage.proto";
import "google/protobuf/descriptor.proto";
import "google/protobuf/duration.proto";

option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
option java_multiple_files = true;
Expand Down Expand Up @@ -97,3 +99,251 @@ extend google.protobuf.ServiceOptions {
// }
string oauth_scopes = 1050;
}

// Required information for every language.
message CommonLanguageSettings {
// Link to automatically generated reference documentation. Example:
// https://cloud.google.com/nodejs/docs/reference/asset/latest
string reference_docs_uri = 1 [deprecated = true];

// The destination where API teams want this client library to be published.
repeated ClientLibraryDestination destinations = 2;
}

// Details about how and where to publish client libraries.
message ClientLibrarySettings {
// Version of the API to apply these settings to.
string version = 1;

// Launch stage of this version of the API.
LaunchStage launch_stage = 2;

// When using transport=rest, the client request will encode enums as
// numbers rather than strings.
bool rest_numeric_enums = 3;

// Settings for legacy Java features, supported in the Service YAML.
JavaSettings java_settings = 21;

// Settings for C++ client libraries.
CppSettings cpp_settings = 22;

// Settings for PHP client libraries.
PhpSettings php_settings = 23;

// Settings for Python client libraries.
PythonSettings python_settings = 24;

// Settings for Node client libraries.
NodeSettings node_settings = 25;

// Settings for .NET client libraries.
DotnetSettings dotnet_settings = 26;

// Settings for Ruby client libraries.
RubySettings ruby_settings = 27;

// Settings for Go client libraries.
GoSettings go_settings = 28;
}

// This message configures the settings for publishing [Google Cloud Client
// libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
// generated from the service config.
message Publishing {
// A list of API method settings, e.g. the behavior for methods that use the
// long-running operation pattern.
repeated MethodSettings method_settings = 2;

// Link to a place that API users can report issues. Example:
// https://issuetracker.google.com/issues/new?component=190865&template=1161103
string new_issue_uri = 101;

// Link to product home page. Example:
// https://cloud.google.com/asset-inventory/docs/overview
string documentation_uri = 102;

// Used as a tracking tag when collecting data about the APIs developer
// relations artifacts like docs, packages delivered to package managers,
// etc. Example: "speech".
string api_short_name = 103;

// GitHub label to apply to issues and pull requests opened for this API.
string github_label = 104;

// GitHub teams to be added to CODEOWNERS in the directory in GitHub
// containing source code for the client libraries for this API.
repeated string codeowner_github_teams = 105;

// A prefix used in sample code when demarking regions to be included in
// documentation.
string doc_tag_prefix = 106;

// For whom the client library is being published.
ClientLibraryOrganization organization = 107;

// Client library settings. If the same version string appears multiple
// times in this list, then the last one wins. Settings from earlier
// settings with the same version string are discarded.
repeated ClientLibrarySettings library_settings = 109;
}

// Settings for Java client libraries.
message JavaSettings {
// The package name to use in Java. Clobbers the java_package option
// set in the protobuf. This should be used **only** by APIs
// who have already set the language_settings.java.package_name" field
// in gapic.yaml. API teams should use the protobuf java_package option
// where possible.
//
// Example of a YAML configuration::
//
// publishing:
// java_settings:
// library_package: com.google.cloud.pubsub.v1
string library_package = 1;

// Configure the Java class name to use instead of the service's for its
// corresponding generated GAPIC client. Keys are fully-qualified
// service names as they appear in the protobuf (including the full
// the language_settings.java.interface_names" field in gapic.yaml. API
// teams should otherwise use the service name as it appears in the
// protobuf.
//
// Example of a YAML configuration::
//
// publishing:
// java_settings:
// service_class_names:
// - google.pubsub.v1.Publisher: TopicAdmin
// - google.pubsub.v1.Subscriber: SubscriptionAdmin
map<string, string> service_class_names = 2;

// Some settings.
CommonLanguageSettings common = 3;
}

// Settings for C++ client libraries.
message CppSettings {
// Some settings.
CommonLanguageSettings common = 1;
}

// Settings for Php client libraries.
message PhpSettings {
// Some settings.
CommonLanguageSettings common = 1;
}

// Settings for Python client libraries.
message PythonSettings {
// Some settings.
CommonLanguageSettings common = 1;
}

// Settings for Node client libraries.
message NodeSettings {
// Some settings.
CommonLanguageSettings common = 1;
}

// Settings for Dotnet client libraries.
message DotnetSettings {
// Some settings.
CommonLanguageSettings common = 1;
}

// Settings for Ruby client libraries.
message RubySettings {
// Some settings.
CommonLanguageSettings common = 1;
}

// Settings for Go client libraries.
message GoSettings {
// Some settings.
CommonLanguageSettings common = 1;
}

// Describes the generator configuration for a method.
message MethodSettings {
// Describes settings to use when generating API methods that use the
// long-running operation pattern.
// All default values below are from those used in the client library
// generators (e.g.
// [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
message LongRunning {
// Initial delay after which the first poll request will be made.
// Default value: 5 seconds.
google.protobuf.Duration initial_poll_delay = 1;

// Multiplier to gradually increase delay between subsequent polls until it
// reaches max_poll_delay.
// Default value: 1.5.
float poll_delay_multiplier = 2;

// Maximum time between two subsequent poll requests.
// Default value: 45 seconds.
google.protobuf.Duration max_poll_delay = 3;

// Total polling timeout.
// Default value: 5 minutes.
google.protobuf.Duration total_poll_timeout = 4;
}

// The fully qualified name of the method, for which the options below apply.
// This is used to find the method to apply the options.
string selector = 1;

// Describes settings to use for long-running operations when generating
// API methods for RPCs. Complements RPCs that use the annotations in
// google/longrunning/operations.proto.
//
// Example of a YAML configuration::
//
// publishing:
// method_behavior:
// - selector: CreateAdDomain
// long_running:
// initial_poll_delay:
// seconds: 60 # 1 minute
// poll_delay_multiplier: 1.5
// max_poll_delay:
// seconds: 360 # 6 minutes
// total_poll_timeout:
// seconds: 54000 # 90 minutes
LongRunning long_running = 2;
}

// The organization for which the client libraries are being published.
// Affects the url where generated docs are published, etc.
enum ClientLibraryOrganization {
// Not useful.
CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0;

// Google Cloud Platform Org.
CLOUD = 1;

// Ads (Advertising) Org.
ADS = 2;

// Photos Org.
PHOTOS = 3;

// Street View Org.
STREET_VIEW = 4;
}

// To where should client libraries be published?
enum ClientLibraryDestination {
// Client libraries will neither be generated nor published to package
// managers.
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0;

// Generate the client library in a repo under github.com/googleapis,
// but don't publish it to package managers.
GITHUB = 10;

// Publish the library to package managers like nuget.org and npmjs.com.
PACKAGE_MANAGER = 20;
}
6 changes: 3 additions & 3 deletions opentelemetry-stackdriver/proto/google/api/launch_stage.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ option java_package = "com.google.api";
option objc_class_prefix = "GAPI";

// The launch stage as defined by [Google Cloud Platform
// Launch Stages](http://cloud.google.com/terms/launch-stages).
// Launch Stages](https://cloud.google.com/terms/launch-stages).
enum LaunchStage {
// Do not use this default value.
LAUNCH_STAGE_UNSPECIFIED = 0;
Expand All @@ -45,7 +45,7 @@ enum LaunchStage {
// for widespread use. By Alpha, all significant design issues are resolved
// and we are in the process of verifying functionality. Alpha customers
// need to apply for access, agree to applicable terms, and have their
// projects allowlisted. Alpha releases don’t have to be feature complete,
// projects allowlisted. Alpha releases don't have to be feature complete,
// no SLAs are provided, and there are no technical support obligations, but
// they will be far enough along that customers can actually use them in
// test environments or for limited-use tests -- just like they would in
Expand All @@ -64,7 +64,7 @@ enum LaunchStage {
GA = 4;

// Deprecated features are scheduled to be shut down and removed. For more
// information, see the “Deprecation Policy” section of our [Terms of
// information, see the "Deprecation Policy" section of our [Terms of
// Service](https://cloud.google.com/terms/)
// and the [Google Cloud Platform Subject to the Deprecation
// Policy](https://cloud.google.com/terms/deprecation) documentation.
Expand Down
11 changes: 9 additions & 2 deletions opentelemetry-stackdriver/proto/google/api/monitored_resource.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ message MonitoredResourceDescriptor {

// Required. The monitored resource type. For example, the type
// `"cloudsql_database"` represents databases in Google Cloud SQL.
// For a list of types, see [Monitoring resource
// types](https://cloud.google.com/monitoring/api/resources)
// and [Logging resource
// types](https://cloud.google.com/logging/docs/api/v2/resource-list).
string type = 1;

// Optional. A concise name for the monitored resource type that might be
Expand Down Expand Up @@ -77,15 +81,18 @@ message MonitoredResourceDescriptor {
// its attributes according to the schema. For example, a particular Compute
// Engine VM instance could be represented by the following object, because the
// [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] for `"gce_instance"` has labels
// `"instance_id"` and `"zone"`:
// `"project_id"`, `"instance_id"` and `"zone"`:
//
// { "type": "gce_instance",
// "labels": { "instance_id": "12345678901234",
// "labels": { "project_id": "my-project",
// "instance_id": "12345678901234",
// "zone": "us-central1-a" }}
message MonitoredResource {
// Required. The monitored resource type. This field must match
// the `type` field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For
// example, the type of a Compute Engine VM instance is `gce_instance`.
// Some descriptors include the service name in the type; for example,
// the type of a Datastream stream is `datastream.googleapis.com/Stream`.
string type = 1;

// Required. Values for all of the labels listed in the associated monitored
Expand Down
Loading

0 comments on commit 592e77a

Please sign in to comment.