genproto: google.golang.org/genproto/googleapis/api/annotations Index | Files

package annotations

import "google.golang.org/genproto/googleapis/api/annotations"

Index

Package Files

annotations.pb.go client.pb.go field_behavior.pb.go http.pb.go resource.pb.go

Variables

var (
    // The hostname for this service.
    // This should be specified with no prefix or protocol.
    //
    // Example:
    //
    //   service Foo {
    //     option (google.api.default_host) = "foo.googleapi.com";
    //     ...
    //   }
    //
    // optional string default_host = 1049;
    E_DefaultHost = &file_google_api_client_proto_extTypes[1]
    // OAuth scopes needed for the client.
    //
    // Example:
    //
    //   service Foo {
    //     option (google.api.oauth_scopes) = \
    //       "https://www.googleapis.com/auth/cloud-platform";
    //     ...
    //   }
    //
    // If there is more than one scope, use a comma-separated string:
    //
    // Example:
    //
    //   service Foo {
    //     option (google.api.oauth_scopes) = \
    //       "https://www.googleapis.com/auth/cloud-platform,"
    //       "https://www.googleapis.com/auth/monitoring";
    //     ...
    //   }
    //
    // optional string oauth_scopes = 1050;
    E_OauthScopes = &file_google_api_client_proto_extTypes[2]
)

Extension fields to descriptor.ServiceOptions.

var (
    FieldBehavior_name = map[int32]string{
        0:  "FIELD_BEHAVIOR_UNSPECIFIED",
        1:  "OPTIONAL",
        2:  "REQUIRED",
        3:  "OUTPUT_ONLY",
        4:  "INPUT_ONLY",
        5:  "IMMUTABLE",
    }
    FieldBehavior_value = map[string]int32{
        "FIELD_BEHAVIOR_UNSPECIFIED": 0,
        "OPTIONAL":                   1,
        "REQUIRED":                   2,
        "OUTPUT_ONLY":                3,
        "INPUT_ONLY":                 4,
        "IMMUTABLE":                  5,
    }
)

Enum value maps for FieldBehavior.

var (
    ResourceDescriptor_History_name = map[int32]string{
        0:  "HISTORY_UNSPECIFIED",
        1:  "ORIGINALLY_SINGLE_PATTERN",
        2:  "FUTURE_MULTI_PATTERN",
    }
    ResourceDescriptor_History_value = map[string]int32{
        "HISTORY_UNSPECIFIED":       0,
        "ORIGINALLY_SINGLE_PATTERN": 1,
        "FUTURE_MULTI_PATTERN":      2,
    }
)

Enum value maps for ResourceDescriptor_History.

var (
    // A designation of a specific field behavior (required, output only, etc.)
    // in protobuf messages.
    //
    // Examples:
    //
    //   string name = 1 [(google.api.field_behavior) = REQUIRED];
    //   State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
    //   google.protobuf.Duration ttl = 1
    //     [(google.api.field_behavior) = INPUT_ONLY];
    //   google.protobuf.Timestamp expire_time = 1
    //     [(google.api.field_behavior) = OUTPUT_ONLY,
    //      (google.api.field_behavior) = IMMUTABLE];
    //
    // repeated google.api.FieldBehavior field_behavior = 1052;
    E_FieldBehavior = &file_google_api_field_behavior_proto_extTypes[0]
)

Extension fields to descriptor.FieldOptions.

var (
    // See `HttpRule`.
    //
    // optional google.api.HttpRule http = 72295728;
    E_Http = &file_google_api_annotations_proto_extTypes[0]
)

Extension fields to descriptor.MethodOptions.

var (
    // A definition of a client library method signature.
    //
    // In client libraries, each proto RPC corresponds to one or more methods
    // which the end user is able to call, and calls the underlying RPC.
    // Normally, this method receives a single argument (a struct or instance
    // corresponding to the RPC request object). Defining this field will
    // add one or more overloads providing flattened or simpler method signatures
    // in some languages.
    //
    // The fields on the method signature are provided as a comma-separated
    // string.
    //
    // For example, the proto RPC and annotation:
    //
    //   rpc CreateSubscription(CreateSubscriptionRequest)
    //       returns (Subscription) {
    //     option (google.api.method_signature) = "name,topic";
    //   }
    //
    // Would add the following Java overload (in addition to the method accepting
    // the request object):
    //
    //   public final Subscription createSubscription(String name, String topic)
    //
    // The following backwards-compatibility guidelines apply:
    //
    //   * Adding this annotation to an unannotated method is backwards
    //     compatible.
    //   * Adding this annotation to a method which already has existing
    //     method signature annotations is backwards compatible if and only if
    //     the new method signature annotation is last in the sequence.
    //   * Modifying or removing an existing method signature annotation is
    //     a breaking change.
    //   * Re-ordering existing method signature annotations is a breaking
    //     change.
    //
    // repeated string method_signature = 1051;
    E_MethodSignature = &file_google_api_client_proto_extTypes[0]
)

Extension fields to descriptor.MethodOptions.

var (
    // An annotation that describes a resource definition, see
    // [ResourceDescriptor][].
    //
    // optional google.api.ResourceDescriptor resource = 1053;
    E_Resource = &file_google_api_resource_proto_extTypes[2]
)

Extension fields to descriptor.MessageOptions.

var (
    // An annotation that describes a resource definition without a corresponding
    // message; see [ResourceDescriptor][].
    //
    // repeated google.api.ResourceDescriptor resource_definition = 1053;
    E_ResourceDefinition = &file_google_api_resource_proto_extTypes[1]
)

Extension fields to descriptor.FileOptions.

var (
    // An annotation that describes a resource reference, see
    // [ResourceReference][].
    //
    // optional google.api.ResourceReference resource_reference = 1055;
    E_ResourceReference = &file_google_api_resource_proto_extTypes[0]
)

Extension fields to descriptor.FieldOptions.

var File_google_api_annotations_proto protoreflect.FileDescriptor
var File_google_api_client_proto protoreflect.FileDescriptor
var File_google_api_field_behavior_proto protoreflect.FileDescriptor
var File_google_api_http_proto protoreflect.FileDescriptor
var File_google_api_resource_proto protoreflect.FileDescriptor

type CustomHttpPattern Uses

type CustomHttpPattern struct {

    // The name of this custom HTTP verb.
    Kind string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"`
    // The path matched by this custom verb.
    Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
    // contains filtered or unexported fields
}

A custom pattern is used for defining custom HTTP verb.

func (*CustomHttpPattern) Descriptor Uses

func (*CustomHttpPattern) Descriptor() ([]byte, []int)

Deprecated: Use CustomHttpPattern.ProtoReflect.Descriptor instead.

func (*CustomHttpPattern) GetKind Uses

func (x *CustomHttpPattern) GetKind() string

func (*CustomHttpPattern) GetPath Uses

func (x *CustomHttpPattern) GetPath() string

func (*CustomHttpPattern) ProtoMessage Uses

func (*CustomHttpPattern) ProtoMessage()

func (*CustomHttpPattern) ProtoReflect Uses

func (x *CustomHttpPattern) ProtoReflect() protoreflect.Message

func (*CustomHttpPattern) Reset Uses

func (x *CustomHttpPattern) Reset()

func (*CustomHttpPattern) String Uses

func (x *CustomHttpPattern) String() string

type FieldBehavior Uses

type FieldBehavior int32

An indicator of the behavior of a given field (for example, that a field is required in requests, or given as output but ignored as input). This **does not** change the behavior in protocol buffers itself; it only denotes the behavior and may affect how API tooling handles the field.

Note: This enum **may** receive new values in the future.

const (
    // Conventional default for enums. Do not use this.
    FieldBehavior_FIELD_BEHAVIOR_UNSPECIFIED FieldBehavior = 0
    // Specifically denotes a field as optional.
    // While all fields in protocol buffers are optional, this may be specified
    // for emphasis if appropriate.
    FieldBehavior_OPTIONAL FieldBehavior = 1
    // Denotes a field as required.
    // This indicates that the field **must** be provided as part of the request,
    // and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
    FieldBehavior_REQUIRED FieldBehavior = 2
    // Denotes a field as output only.
    // This indicates that the field is provided in responses, but including the
    // field in a request does nothing (the server *must* ignore it and
    // *must not* throw an error as a result of the field's presence).
    FieldBehavior_OUTPUT_ONLY FieldBehavior = 3
    // Denotes a field as input only.
    // This indicates that the field is provided in requests, and the
    // corresponding field is not included in output.
    FieldBehavior_INPUT_ONLY FieldBehavior = 4
    // Denotes a field as immutable.
    // This indicates that the field may be set once in a request to create a
    // resource, but may not be changed thereafter.
    FieldBehavior_IMMUTABLE FieldBehavior = 5
)

func (FieldBehavior) Descriptor Uses

func (FieldBehavior) Descriptor() protoreflect.EnumDescriptor

func (FieldBehavior) Enum Uses

func (x FieldBehavior) Enum() *FieldBehavior

func (FieldBehavior) EnumDescriptor Uses

func (FieldBehavior) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldBehavior.Descriptor instead.

func (FieldBehavior) Number Uses

func (x FieldBehavior) Number() protoreflect.EnumNumber

func (FieldBehavior) String Uses

func (x FieldBehavior) String() string

func (FieldBehavior) Type Uses

func (FieldBehavior) Type() protoreflect.EnumType

type Http Uses

type Http struct {

    // A list of HTTP configuration rules that apply to individual API methods.
    //
    // **NOTE:** All service configuration rules follow "last one wins" order.
    Rules []*HttpRule `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
    // When set to true, URL path parameters will be fully URI-decoded except in
    // cases of single segment matches in reserved expansion, where "%2F" will be
    // left encoded.
    //
    // The default behavior is to not decode RFC 6570 reserved characters in multi
    // segment matches.
    FullyDecodeReservedExpansion bool `protobuf:"varint,2,opt,name=fully_decode_reserved_expansion,json=fullyDecodeReservedExpansion,proto3" json:"fully_decode_reserved_expansion,omitempty"`
    // contains filtered or unexported fields
}

Defines the HTTP configuration for an API service. It contains a list of [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method to one or more HTTP REST API methods.

func (*Http) Descriptor Uses

func (*Http) Descriptor() ([]byte, []int)

Deprecated: Use Http.ProtoReflect.Descriptor instead.

func (*Http) GetFullyDecodeReservedExpansion Uses

func (x *Http) GetFullyDecodeReservedExpansion() bool

func (*Http) GetRules Uses

func (x *Http) GetRules() []*HttpRule

func (*Http) ProtoMessage Uses

func (*Http) ProtoMessage()

func (*Http) ProtoReflect Uses

func (x *Http) ProtoReflect() protoreflect.Message

func (*Http) Reset Uses

func (x *Http) Reset()

func (*Http) String Uses

func (x *Http) String() string

type HttpRule Uses

type HttpRule struct {

    // Selects a method to which this rule applies.
    //
    // Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
    Selector string `protobuf:"bytes,1,opt,name=selector,proto3" json:"selector,omitempty"`
    // Determines the URL pattern is matched by this rules. This pattern can be
    // used with any of the {get|put|post|delete|patch} methods. A custom method
    // can be defined using the 'custom' field.
    //
    // Types that are assignable to Pattern:
    //	*HttpRule_Get
    //	*HttpRule_Put
    //	*HttpRule_Post
    //	*HttpRule_Delete
    //	*HttpRule_Patch
    //	*HttpRule_Custom
    Pattern isHttpRule_Pattern `protobuf_oneof:"pattern"`
    // The name of the request field whose value is mapped to the HTTP request
    // body, or `*` for mapping all request fields not captured by the path
    // pattern to the HTTP body, or omitted for not having any HTTP request body.
    //
    // NOTE: the referred field must be present at the top-level of the request
    // message type.
    Body string `protobuf:"bytes,7,opt,name=body,proto3" json:"body,omitempty"`
    // Optional. The name of the response field whose value is mapped to the HTTP
    // response body. When omitted, the entire response message will be used
    // as the HTTP response body.
    //
    // NOTE: The referred field must be present at the top-level of the response
    // message type.
    ResponseBody string `protobuf:"bytes,12,opt,name=response_body,json=responseBody,proto3" json:"response_body,omitempty"`
    // Additional HTTP bindings for the selector. Nested bindings must
    // not contain an `additional_bindings` field themselves (that is,
    // the nesting may only be one level deep).
    AdditionalBindings []*HttpRule `protobuf:"bytes,11,rep,name=additional_bindings,json=additionalBindings,proto3" json:"additional_bindings,omitempty"`
    // contains filtered or unexported fields
}

# gRPC Transcoding

gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services.

`HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method.

Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path.

Example:

service Messaging {
  rpc GetMessage(GetMessageRequest) returns (Message) {
    option (google.api.http) = {
        get: "/v1/{name=messages/*}"
    };
  }
}
message GetMessageRequest {
  string name = 1; // Mapped to URL path.
}
message Message {
  string text = 1; // The resource content.
}

This enables an HTTP REST to gRPC mapping as below:

HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`

Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example:

service Messaging {
  rpc GetMessage(GetMessageRequest) returns (Message) {
    option (google.api.http) = {
        get:"/v1/messages/{message_id}"
    };
  }
}
message GetMessageRequest {
  message SubMessage {
    string subfield = 1;
  }
  string message_id = 1; // Mapped to URL path.
  int64 revision = 2;    // Mapped to URL query parameter `revision`.
  SubMessage sub = 3;    // Mapped to URL query parameter `sub.subfield`.
}

This enables a HTTP JSON to RPC mapping as below:

HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))`

Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`.

For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection:

service Messaging {
  rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
    option (google.api.http) = {
      patch: "/v1/messages/{message_id}"
      body: "message"
    };
  }
}
message UpdateMessageRequest {
  string message_id = 1; // mapped to the URL
  Message message = 2;   // mapped to the body
}

The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding:

HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })`

The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method:

service Messaging {
  rpc UpdateMessage(Message) returns (Message) {
    option (google.api.http) = {
      patch: "/v1/messages/{message_id}"
      body: "*"
    };
  }
}
message Message {
  string message_id = 1;
  string text = 2;
}

The following HTTP JSON to RPC mapping is enabled:

HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")`

Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data.

It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example:

service Messaging {
  rpc GetMessage(GetMessageRequest) returns (Message) {
    option (google.api.http) = {
      get: "/v1/messages/{message_id}"
      additional_bindings {
        get: "/v1/users/{user_id}/messages/{message_id}"
      }
    };
  }
}
message GetMessageRequest {
  string message_id = 1;
  string user_id = 2;
}

This enables the following two alternative HTTP JSON to RPC mappings:

HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")`

## Rules for HTTP mapping

1. Leaf request fields (recursive expansion nested messages in the request

  message) are classified into three categories:
  - Fields referred by the path template. They are passed via the URL path.
  - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They are passed via the HTTP
    request body.
  - All other fields are passed via the URL query parameters, and the
    parameter name is the field path in the request message. A repeated
    field can be represented as multiple query parameters under the same
    name.
2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL query parameter, all fields
   are passed via URL path and HTTP request body.
3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP request body, all
   fields are passed via URL path and URL query parameters.

### Path template syntax

Template = "/" Segments [ Verb ] ;
Segments = Segment { "/" Segment } ;
Segment  = "*" | "**" | LITERAL | Variable ;
Variable = "{" FieldPath [ "=" Segments ] "}" ;
FieldPath = IDENT { "." IDENT } ;
Verb     = ":" LITERAL ;

The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`.

The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`.

The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching.

If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`.

If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`.

## Using gRPC API Service Configuration

gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message.

As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto.

Example:

http:
  rules:
    # Selects a gRPC method and applies HttpRule to it.
    - selector: example.v1.Messaging.GetMessage
      get: /v1/messages/{message_id}/{sub.subfield}

## Special notes

When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json).

While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables.

The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion.

The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior.

Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping.

If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.

func (*HttpRule) Descriptor Uses

func (*HttpRule) Descriptor() ([]byte, []int)

Deprecated: Use HttpRule.ProtoReflect.Descriptor instead.

func (*HttpRule) GetAdditionalBindings Uses

func (x *HttpRule) GetAdditionalBindings() []*HttpRule

func (*HttpRule) GetBody Uses

func (x *HttpRule) GetBody() string

func (*HttpRule) GetCustom Uses

func (x *HttpRule) GetCustom() *CustomHttpPattern

func (*HttpRule) GetDelete Uses

func (x *HttpRule) GetDelete() string

func (*HttpRule) GetGet Uses

func (x *HttpRule) GetGet() string

func (*HttpRule) GetPatch Uses

func (x *HttpRule) GetPatch() string

func (*HttpRule) GetPattern Uses

func (m *HttpRule) GetPattern() isHttpRule_Pattern

func (*HttpRule) GetPost Uses

func (x *HttpRule) GetPost() string

func (*HttpRule) GetPut Uses

func (x *HttpRule) GetPut() string

func (*HttpRule) GetResponseBody Uses

func (x *HttpRule) GetResponseBody() string

func (*HttpRule) GetSelector Uses

func (x *HttpRule) GetSelector() string

func (*HttpRule) ProtoMessage Uses

func (*HttpRule) ProtoMessage()

func (*HttpRule) ProtoReflect Uses

func (x *HttpRule) ProtoReflect() protoreflect.Message

func (*HttpRule) Reset Uses

func (x *HttpRule) Reset()

func (*HttpRule) String Uses

func (x *HttpRule) String() string

type HttpRule_Custom Uses

type HttpRule_Custom struct {
    // The custom pattern is used for specifying an HTTP method that is not
    // included in the `pattern` field, such as HEAD, or "*" to leave the
    // HTTP method unspecified for this rule. The wild-card rule is useful
    // for services that provide content to Web (HTML) clients.
    Custom *CustomHttpPattern `protobuf:"bytes,8,opt,name=custom,proto3,oneof"`
}

type HttpRule_Delete Uses

type HttpRule_Delete struct {
    // Maps to HTTP DELETE. Used for deleting a resource.
    Delete string `protobuf:"bytes,5,opt,name=delete,proto3,oneof"`
}

type HttpRule_Get Uses

type HttpRule_Get struct {
    // Maps to HTTP GET. Used for listing and getting information about
    // resources.
    Get string `protobuf:"bytes,2,opt,name=get,proto3,oneof"`
}

type HttpRule_Patch Uses

type HttpRule_Patch struct {
    // Maps to HTTP PATCH. Used for updating a resource.
    Patch string `protobuf:"bytes,6,opt,name=patch,proto3,oneof"`
}

type HttpRule_Post Uses

type HttpRule_Post struct {
    // Maps to HTTP POST. Used for creating a resource or performing an action.
    Post string `protobuf:"bytes,4,opt,name=post,proto3,oneof"`
}

type HttpRule_Put Uses

type HttpRule_Put struct {
    // Maps to HTTP PUT. Used for replacing a resource.
    Put string `protobuf:"bytes,3,opt,name=put,proto3,oneof"`
}

type ResourceDescriptor Uses

type ResourceDescriptor struct {

    // The resource type. It must be in the format of
    // {service_name}/{resource_type_kind}. The `resource_type_kind` must be
    // singular and must not include version numbers.
    //
    // Example: `storage.googleapis.com/Bucket`
    //
    // The value of the resource_type_kind must follow the regular expression
    // /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
    // should use PascalCase (UpperCamelCase). The maximum number of
    // characters allowed for the `resource_type_kind` is 100.
    Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
    // Optional. The relative resource name pattern associated with this resource
    // type. The DNS prefix of the full resource name shouldn't be specified here.
    //
    // The path pattern must follow the syntax, which aligns with HTTP binding
    // syntax:
    //
    //     Template = Segment { "/" Segment } ;
    //     Segment = LITERAL | Variable ;
    //     Variable = "{" LITERAL "}" ;
    //
    // Examples:
    //
    //     - "projects/{project}/topics/{topic}"
    //     - "projects/{project}/knowledgeBases/{knowledge_base}"
    //
    // The components in braces correspond to the IDs for each resource in the
    // hierarchy. It is expected that, if multiple patterns are provided,
    // the same component name (e.g. "project") refers to IDs of the same
    // type of resource.
    Pattern []string `protobuf:"bytes,2,rep,name=pattern,proto3" json:"pattern,omitempty"`
    // Optional. The field on the resource that designates the resource name
    // field. If omitted, this is assumed to be "name".
    NameField string `protobuf:"bytes,3,opt,name=name_field,json=nameField,proto3" json:"name_field,omitempty"`
    // Optional. The historical or future-looking state of the resource pattern.
    //
    // Example:
    //
    //     // The InspectTemplate message originally only supported resource
    //     // names with organization, and project was added later.
    //     message InspectTemplate {
    //       option (google.api.resource) = {
    //         type: "dlp.googleapis.com/InspectTemplate"
    //         pattern:
    //         "organizations/{organization}/inspectTemplates/{inspect_template}"
    //         pattern: "projects/{project}/inspectTemplates/{inspect_template}"
    //         history: ORIGINALLY_SINGLE_PATTERN
    //       };
    //     }
    History ResourceDescriptor_History `protobuf:"varint,4,opt,name=history,proto3,enum=google.api.ResourceDescriptor_History" json:"history,omitempty"`
    // The plural name used in the resource name, such as 'projects' for
    // the name of 'projects/{project}'. It is the same concept of the `plural`
    // field in k8s CRD spec
    // https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
    Plural string `protobuf:"bytes,5,opt,name=plural,proto3" json:"plural,omitempty"`
    // The same concept of the `singular` field in k8s CRD spec
    // https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
    // Such as "project" for the `resourcemanager.googleapis.com/Project` type.
    Singular string `protobuf:"bytes,6,opt,name=singular,proto3" json:"singular,omitempty"`
    // contains filtered or unexported fields
}

A simple descriptor of a resource type.

ResourceDescriptor annotates a resource message (either by means of a protobuf annotation or use in the service config), and associates the resource's schema, the resource type, and the pattern of the resource name.

Example:

message Topic {
  // Indicates this message defines a resource schema.
  // Declares the resource type in the format of {service}/{kind}.
  // For Kubernetes resources, the format is {api group}/{kind}.
  option (google.api.resource) = {
    type: "pubsub.googleapis.com/Topic"
    name_descriptor: {
      pattern: "projects/{project}/topics/{topic}"
      parent_type: "cloudresourcemanager.googleapis.com/Project"
      parent_name_extractor: "projects/{project}"
    }
  };
}

The ResourceDescriptor Yaml config will look like:

resources:
- type: "pubsub.googleapis.com/Topic"
  name_descriptor:
    - pattern: "projects/{project}/topics/{topic}"
      parent_type: "cloudresourcemanager.googleapis.com/Project"
      parent_name_extractor: "projects/{project}"

Sometimes, resources have multiple patterns, typically because they can live under multiple parents.

Example:

message LogEntry {
  option (google.api.resource) = {
    type: "logging.googleapis.com/LogEntry"
    name_descriptor: {
      pattern: "projects/{project}/logs/{log}"
      parent_type: "cloudresourcemanager.googleapis.com/Project"
      parent_name_extractor: "projects/{project}"
    }
    name_descriptor: {
      pattern: "folders/{folder}/logs/{log}"
      parent_type: "cloudresourcemanager.googleapis.com/Folder"
      parent_name_extractor: "folders/{folder}"
    }
    name_descriptor: {
      pattern: "organizations/{organization}/logs/{log}"
      parent_type: "cloudresourcemanager.googleapis.com/Organization"
      parent_name_extractor: "organizations/{organization}"
    }
    name_descriptor: {
      pattern: "billingAccounts/{billing_account}/logs/{log}"
      parent_type: "billing.googleapis.com/BillingAccount"
      parent_name_extractor: "billingAccounts/{billing_account}"
    }
  };
}

The ResourceDescriptor Yaml config will look like:

resources:
- type: 'logging.googleapis.com/LogEntry'
  name_descriptor:
    - pattern: "projects/{project}/logs/{log}"
      parent_type: "cloudresourcemanager.googleapis.com/Project"
      parent_name_extractor: "projects/{project}"
    - pattern: "folders/{folder}/logs/{log}"
      parent_type: "cloudresourcemanager.googleapis.com/Folder"
      parent_name_extractor: "folders/{folder}"
    - pattern: "organizations/{organization}/logs/{log}"
      parent_type: "cloudresourcemanager.googleapis.com/Organization"
      parent_name_extractor: "organizations/{organization}"
    - pattern: "billingAccounts/{billing_account}/logs/{log}"
      parent_type: "billing.googleapis.com/BillingAccount"
      parent_name_extractor: "billingAccounts/{billing_account}"

For flexible resources, the resource name doesn't contain parent names, but the resource itself has parents for policy evaluation.

Example:

message Shelf {
  option (google.api.resource) = {
    type: "library.googleapis.com/Shelf"
    name_descriptor: {
      pattern: "shelves/{shelf}"
      parent_type: "cloudresourcemanager.googleapis.com/Project"
    }
    name_descriptor: {
      pattern: "shelves/{shelf}"
      parent_type: "cloudresourcemanager.googleapis.com/Folder"
    }
  };
}

The ResourceDescriptor Yaml config will look like:

resources:
- type: 'library.googleapis.com/Shelf'
  name_descriptor:
    - pattern: "shelves/{shelf}"
      parent_type: "cloudresourcemanager.googleapis.com/Project"
    - pattern: "shelves/{shelf}"
      parent_type: "cloudresourcemanager.googleapis.com/Folder"

func (*ResourceDescriptor) Descriptor Uses

func (*ResourceDescriptor) Descriptor() ([]byte, []int)

Deprecated: Use ResourceDescriptor.ProtoReflect.Descriptor instead.

func (*ResourceDescriptor) GetHistory Uses

func (x *ResourceDescriptor) GetHistory() ResourceDescriptor_History

func (*ResourceDescriptor) GetNameField Uses

func (x *ResourceDescriptor) GetNameField() string

func (*ResourceDescriptor) GetPattern Uses

func (x *ResourceDescriptor) GetPattern() []string

func (*ResourceDescriptor) GetPlural Uses

func (x *ResourceDescriptor) GetPlural() string

func (*ResourceDescriptor) GetSingular Uses

func (x *ResourceDescriptor) GetSingular() string

func (*ResourceDescriptor) GetType Uses

func (x *ResourceDescriptor) GetType() string

func (*ResourceDescriptor) ProtoMessage Uses

func (*ResourceDescriptor) ProtoMessage()

func (*ResourceDescriptor) ProtoReflect Uses

func (x *ResourceDescriptor) ProtoReflect() protoreflect.Message

func (*ResourceDescriptor) Reset Uses

func (x *ResourceDescriptor) Reset()

func (*ResourceDescriptor) String Uses

func (x *ResourceDescriptor) String() string

type ResourceDescriptor_History Uses

type ResourceDescriptor_History int32

A description of the historical or future-looking state of the resource pattern.

const (
    // The "unset" value.
    ResourceDescriptor_HISTORY_UNSPECIFIED ResourceDescriptor_History = 0
    // The resource originally had one pattern and launched as such, and
    // additional patterns were added later.
    ResourceDescriptor_ORIGINALLY_SINGLE_PATTERN ResourceDescriptor_History = 1
    // The resource has one pattern, but the API owner expects to add more
    // later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
    // that from being necessary once there are multiple patterns.)
    ResourceDescriptor_FUTURE_MULTI_PATTERN ResourceDescriptor_History = 2
)

func (ResourceDescriptor_History) Descriptor Uses

func (ResourceDescriptor_History) Descriptor() protoreflect.EnumDescriptor

func (ResourceDescriptor_History) Enum Uses

func (x ResourceDescriptor_History) Enum() *ResourceDescriptor_History

func (ResourceDescriptor_History) EnumDescriptor Uses

func (ResourceDescriptor_History) EnumDescriptor() ([]byte, []int)

Deprecated: Use ResourceDescriptor_History.Descriptor instead.

func (ResourceDescriptor_History) Number Uses

func (x ResourceDescriptor_History) Number() protoreflect.EnumNumber

func (ResourceDescriptor_History) String Uses

func (x ResourceDescriptor_History) String() string

func (ResourceDescriptor_History) Type Uses

func (ResourceDescriptor_History) Type() protoreflect.EnumType

type ResourceReference Uses

type ResourceReference struct {

    // The resource type that the annotated field references.
    //
    // Example:
    //
    //     message Subscription {
    //       string topic = 2 [(google.api.resource_reference) = {
    //         type: "pubsub.googleapis.com/Topic"
    //       }];
    //     }
    Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
    // The resource type of a child collection that the annotated field
    // references. This is useful for annotating the `parent` field that
    // doesn't have a fixed resource type.
    //
    // Example:
    //
    //     message ListLogEntriesRequest {
    //       string parent = 1 [(google.api.resource_reference) = {
    //         child_type: "logging.googleapis.com/LogEntry"
    //       };
    //     }
    ChildType string `protobuf:"bytes,2,opt,name=child_type,json=childType,proto3" json:"child_type,omitempty"`
    // contains filtered or unexported fields
}

Defines a proto annotation that describes a string field that refers to an API resource.

func (*ResourceReference) Descriptor Uses

func (*ResourceReference) Descriptor() ([]byte, []int)

Deprecated: Use ResourceReference.ProtoReflect.Descriptor instead.

func (*ResourceReference) GetChildType Uses

func (x *ResourceReference) GetChildType() string

func (*ResourceReference) GetType Uses

func (x *ResourceReference) GetType() string

func (*ResourceReference) ProtoMessage Uses

func (*ResourceReference) ProtoMessage()

func (*ResourceReference) ProtoReflect Uses

func (x *ResourceReference) ProtoReflect() protoreflect.Message

func (*ResourceReference) Reset Uses

func (x *ResourceReference) Reset()

func (*ResourceReference) String Uses

func (x *ResourceReference) String() string

Package annotations imports 6 packages (graph) and is imported by 893 packages. Updated 2020-05-15. Refresh now. Tools for package owners.