@datafire/google_servicenetworking v3.0.0

@datafire/google_servicenetworking

Client library for Service Networking API

Installation and Usage

npm install --save @datafire/google_servicenetworking

let google_servicenetworking = require('@datafire/google_servicenetworking').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Provides automatic management of network configurations necessary for certain services.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_servicenetworking.oauthCallback({
  "code": ""
}, context)

Input

• input object
  • code required string

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_servicenetworking.oauthRefresh(null, context)

Input

This action has no parameters

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

servicenetworking.operations.get

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

google_servicenetworking.servicenetworking.operations.get({
  "name": ""
}, context)

Input

• input object
  • name required string: The name of the operation resource.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

servicenetworking.services.updateConnections

Updates the allocated ranges that are assigned to a connection. The response from the get operation will be of type Connection if the operation successfully completes.

google_servicenetworking.servicenetworking.services.updateConnections({
  "name": ""
}, context)

Input

• input object
  • name required string: The service producer peering service that is managing peering connectivity for a service producer organization. For Google services that support this functionality, this is services/servicenetworking.googleapis.com.
  • force boolean: If a previously defined allocated range is removed, force flag must be set to true.
  • updateMask string: The update mask. If this is omitted, it defaults to "*". You can only update the listed peering ranges.
  • body Connection
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

servicenetworking.services.connections.list

List the private connections that are configured in a service consumer's VPC network.

google_servicenetworking.servicenetworking.services.connections.list({
  "parent": ""
}, context)

Input

• input object
  • parent required string: The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com. If you specify - as the parameter value, all configured public peering services are listed.
  • network string: The name of service consumer's VPC network that's connected with service producer network through a private connection. The network name must be in the following format: projects/{project}/global/networks/{network}. {project} is a project number, such as in 12345 that includes the VPC service consumer's VPC network. {network} is the name of the service consumer's VPC network.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output ListConnectionsResponse

servicenetworking.services.connections.create

Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of the service consumer's VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer's VPC network. This connection is used for all supported services in the service producer's organization, so it only needs to be invoked once. The response from the get operation will be of type Connection if the operation successfully completes.

google_servicenetworking.servicenetworking.services.connections.create({
  "parent": ""
}, context)

Input

• input object
  • parent required string: The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com.
  • body Connection
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

servicenetworking.services.addSubnetwork

For service producers, provisions a new subnet in a peered service's shared VPC network in the requested region and with the requested size that's expressed as a CIDR range (number of leading bits of ipV4 network mask). The method checks against the assigned allocated ranges to find a non-conflicting IP address range. The method will reuse a subnet if subsequent calls contain the same subnet name, region, and prefix length. This method will make producer's tenant project to be a shared VPC service project as needed. The response from the get operation will be of type Subnetwork if the operation successfully completes.

google_servicenetworking.servicenetworking.services.addSubnetwork({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Required. A tenant project in the service producer organization, in the following format: services/{service}/{collection-id}/{resource-id}. {collection-id} is the cloud resource collection type that represents the tenant project. Only projects are supported. {resource-id} is the tenant project numeric id, such as 123456. {service} the name of the peering service, such as service-peering.example.com. This service must already be enabled in the service consumer's project.
  • body AddSubnetworkRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

servicenetworking.services.searchRange

Service producers can use this method to find a currently unused range within consumer allocated ranges. This returned range is not reserved, and not guaranteed to remain unused. It will validate previously provided allocated ranges, find non-conflicting sub-range of requested size (expressed in number of leading bits of ipv4 network mask, as in CIDR range notation). Operation

google_servicenetworking.servicenetworking.services.searchRange({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Required. This is in a form services/{service}. {service} the name of the private access management service, for example 'service-peering.example.com'.
  • body SearchRangeRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

Definitions

AddDnsRecordSetMetadata

• AddDnsRecordSetMetadata object: Metadata provided through GetOperation request for the LRO generated by AddDnsRecordSet API

AddDnsZoneMetadata

• AddDnsZoneMetadata object: Metadata provided through GetOperation request for the LRO generated by AddDnsZone API

AddDnsZoneResponse

• AddDnsZoneResponse object: Represents managed DNS zones created in the shared producer host and consumer projects.
  • consumerPeeringZone DnsZone
  • producerPrivateZone DnsZone

AddRolesMetadata

• AddRolesMetadata object: Metadata provided through GetOperation request for the LRO generated by AddRoles API

AddRolesResponse

• AddRolesResponse object: Represents IAM roles added to the shared VPC host project.
  • policyBinding array: Required. List of policy bindings that were added to the shared VPC host project.
    • items PolicyBinding

AddSubnetworkRequest

• AddSubnetworkRequest object: Request to create a subnetwork in a previously peered service network.
  • consumer string: Required. A resource that represents the service consumer, such as projects/123456. The project number can be different from the value in the consumer network parameter. For example, the network might be part of a Shared VPC network. In those cases, Service Networking validates that this resource belongs to that Shared VPC.
  • consumerNetwork string: Required. The name of the service consumer's VPC network. The network must have an existing private connection that was provisioned through the connections.create method. The name must be in the following format: projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345. {network} is the name of a VPC network in the project.
  • description string: An optional description of the subnet.
  • ipPrefixLength integer: Required. The prefix length of the subnet's IP address range. Use CIDR range notation, such as 30 to provision a subnet with an x.x.x.x/30 CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range.
  • region string: Required. The name of a region for the subnet, such europe-west1.
  • requestedAddress string: Optional. The starting address of a range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix range is the CIDR range for the subnet. The range must be within the allocated range that is assigned to the private connection. If the CIDR range isn't available, the call fails.
  • subnetwork string: Required. A name for the new subnet. For information about the naming requirements, see subnetwork in the Compute API documentation.
  • subnetworkUsers array: A list of members that are granted the compute.networkUser role on the subnet.
    • items string

Api

• Api object: Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.
  • methods array: The methods of this interface, in unspecified order.
    • items Method
  • mixins array: Included interfaces. See Mixin.
    • items Mixin
  • name string: The fully qualified name of this interface, including package name followed by the interface's simple name.
  • options array: Any metadata attached to the interface.
    • items Option
  • sourceContext SourceContext
  • syntax string (values: SYNTAX_PROTO2, SYNTAX_PROTO3): The source syntax of the service.
  • version string: A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

AuthProvider

• AuthProvider object: Configuration for an authentication provider, including support for JSON Web Token (JWT).
  • audiences string: The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
  • authorizationUrl string: Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
  • id string: The unique identifier of the auth provider. It will be referred to by AuthRequirement.provider_id. Example: "bookstore_auth".
  • issuer string: Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
  • jwksUri string: URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
  • jwtLocations array: Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token
    • items JwtLocation

AuthRequirement

• AuthRequirement object: User-defined authentication requirements, including support for JSON Web Token (JWT).
  • audiences string: NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
  • providerId string: id from authentication provider. Example: provider_id: bookstore_auth

Authentication

• Authentication object: Authentication defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth
  • providers array: Defines a set of authentication providers that a service supports.
    • items AuthProvider
  • rules array: A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
    • items AuthenticationRule

AuthenticationRule

• AuthenticationRule object: Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored.
  • allowWithoutCredential boolean: If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
  • oauth OAuthRequirements
  • requirements array: Requirements for additional authentication providers.
    • items AuthRequirement
  • selector string: Selects the methods to which this rule applies. Refer to selector for syntax details.

Backend

• Backend object: Backend defines the backend configuration for a service.
  • rules array: A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
    • items BackendRule

BackendRule

• BackendRule object: A backend rule provides configuration for an individual API element.
  • address string: The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.
  • deadline number: The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
  • disableAuth boolean: When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.
  • jwtAudience string: The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.
  • minDeadline number: Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.
  • operationDeadline number: The number of seconds to wait for the completion of a long running operation. The default is no deadline.
  • pathTranslation string (values: PATH_TRANSLATION_UNSPECIFIED, CONSTANT_ADDRESS, APPEND_PATH_TO_ADDRESS)
  • protocol string: The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
  • selector string: Selects the methods to which this rule applies. Refer to selector for syntax details.

Billing

• Billing object: Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, consumer_destinations is the only supported destination and the monitored resources need at least one label key cloud.googleapis.com/location to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count
  • consumerDestinations array: Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.
    • items BillingDestination

BillingDestination

• BillingDestination object: Configuration of a specific billing destination (Currently only support bill against consumer project).
  • metrics array: Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
    • items string
  • monitoredResource string: The monitored resource type. The type must be defined in Service.monitored_resources section.

Connection

• Connection object: Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer's VPC network and a service consumer's VPC network.
  • network string: The name of service consumer's VPC network that's connected with service producer network, in the following format: projects/{project}/global/networks/{network}. {project} is a project number, such as in 12345 that includes the VPC service consumer's VPC network. {network} is the name of the service consumer's VPC network.
  • peering string: Output only. The name of the VPC Network Peering connection that was created by the service producer.
  • reservedPeeringRanges array: The name of one or more allocated IP address ranges for this service producer of type PEERING. Note that invoking this method with a different range when connection is already established will not modify already provisioned service producer subnetworks.
    • items string
  • service string: Output only. The name of the peering service that's associated with this connection, in the following format: services/{service name}.

ConsumerConfig

• ConsumerConfig object: Configuration information for a private service access connection.
  • consumerExportCustomRoutes boolean: Export custom routes flag value for peering from consumer to producer.
  • consumerExportSubnetRoutesWithPublicIp boolean: Export subnet routes with public ip flag value for peering from consumer to producer.
  • consumerImportCustomRoutes boolean: Import custom routes flag value for peering from consumer to producer.
  • consumerImportSubnetRoutesWithPublicIp boolean: Import subnet routes with public ip flag value for peering from consumer to producer.
  • producerExportCustomRoutes boolean: Export custom routes flag value for peering from producer to consumer.
  • producerExportSubnetRoutesWithPublicIp boolean: Export subnet routes with public ip flag value for peering from producer to consumer.
  • producerImportCustomRoutes boolean: Import custom routes flag value for peering from producer to consumer.
  • producerImportSubnetRoutesWithPublicIp boolean: Import subnet routes with public ip flag value for peering from producer to consumer.
  • producerNetwork string: Output only. The VPC host network that is used to host managed service instances. In the format, projects/{project}/global/networks/{network} where {project} is the project number e.g. '12345' and {network} is the network name.
  • reservedRanges array: Output only. The reserved ranges associated with this private service access connection.
    • items GoogleCloudServicenetworkingV1ConsumerConfigReservedRange

ConsumerConfigMetadata

• ConsumerConfigMetadata object: Metadata provided through GetOperation request for the LRO generated by UpdateConsumerConfig API.

Context

• Context object: Context defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request google.rpc.context.ProjectContext and google.rpc.context.OriginContext. Available context types are defined in package google.rpc.context. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.
  • rules array: A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
    • items ContextRule

ContextRule

• ContextRule object: A context rule provides information about the context for an individual API element.
  • allowedRequestExtensions array: A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
    • items string
  • allowedResponseExtensions array: A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
    • items string
  • provided array: A list of full type names of provided contexts.
    • items string
  • requested array: A list of full type names of requested contexts.
    • items string
  • selector string: Selects the methods to which this rule applies. Refer to selector for syntax details.

Control

• Control object: Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.
  • environment string: The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.

CustomError

• CustomError object: Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError
  • rules array: The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
    • items CustomErrorRule
  • types array: The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
    • items string

CustomErrorRule

• CustomErrorRule object: A custom error rule.
  • isErrorType boolean: Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
  • selector string: Selects messages to which this rule applies. Refer to selector for syntax details.

CustomHttpPattern

• CustomHttpPattern object: A custom pattern is used for defining custom HTTP verb.
  • kind string: The name of this custom HTTP verb.
  • path string: The path matched by this custom verb.

DeletePeeredDnsDomainMetadata

• DeletePeeredDnsDomainMetadata object: Metadata provided through GetOperation request for the LRO generated by DeletePeeredDnsDomain API.

DnsRecordSet

• DnsRecordSet object: Represents a DNS record set resource.
  • data array: Required. As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) for examples see https://cloud.google.com/dns/records/json-record.
    • items string
  • domain string: Required. The DNS or domain name of the record set, e.g. test.example.com.
  • ttl string: Required. The period of time for which this RecordSet can be cached by resolvers.
  • type string: Required. The identifier of a supported record type.

DnsZone

• DnsZone object: Represents a DNS zone resource.
  • dnsSuffix string: The DNS name suffix of this zone e.g. example.com..
  • name string: User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.

Documentation

• Documentation object: Documentation provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: fully.qualified.proto.name To override the display text used for the link, this can be used: display text Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The include directive includes a markdown file from an external source: (== include path/to/file ==) The resource_for directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive suppress_warning does not directly affect documentation and is documented together with service config validation.
  • documentationRootUrl string: The URL to the root of documentation.
  • overview string: Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field.
  • pages array: The top level pages for the documentation set.
    • items Page
  • rules array: A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
    • items DocumentationRule
  • serviceRootUrl string: Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.
  • summary string: A short summary of what the service does. Can only be provided by plain text.

DocumentationRule

• DocumentationRule object: A documentation rule provides information about individual API elements.
  • deprecationDescription string: Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.
  • description string: Description of the selected API(s).
  • selector string: The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b" or "foo..bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

Endpoint

• Endpoint object: Endpoint describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true
  • aliases array: DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
    • items string
  • allowCors boolean: Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
  • name string: The canonical name of this endpoint.
  • target string: The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

Enum

• Enum object: Enum type definition.
  • enumvalue array: Enum value definitions.
    • items EnumValue
  • name string: Enum type name.
  • options array: Protocol buffer options.
    • items Option
  • sourceContext SourceContext
  • syntax string (values: SYNTAX_PROTO2, SYNTAX_PROTO3): The source syntax.

EnumValue

• EnumValue object: Enum value definition.
  • name string: Enum value name.
  • number integer: Enum value number.
  • options array: Protocol buffer options.
    • items Option

Field

• Field object: A single field of a message type.
  • cardinality string (values: CARDINALITY_UNKNOWN, CARDINALITY_OPTIONAL, CARDINALITY_REQUIRED, CARDINALITY_REPEATED): The field cardinality.
  • defaultValue string: The string value of the default value of this field. Proto2 syntax only.
  • jsonName string: The field JSON name.
  • kind string (values: TYPE_UNKNOWN, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INT64, TYPE_UINT64, TYPE_INT32, TYPE_FIXED64, TYPE_FIXED32, TYPE_BOOL, TYPE_STRING, TYPE_GROUP, TYPE_MESSAGE, TYPE_BYTES, TYPE_UINT32, TYPE_ENUM, TYPE_SFIXED32, TYPE_SFIXED64, TYPE_SINT32, TYPE_SINT64): The field type.
  • name string: The field name.
  • number integer: The field number.
  • oneofIndex integer: The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.
  • options array: The protocol buffer options.
    • items Option
  • packed boolean: Whether to use alternative packed wire representation.
  • typeUrl string: The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

GoogleCloudServicenetworkingV1ConsumerConfigReservedRange

• GoogleCloudServicenetworkingV1ConsumerConfigReservedRange object: Allocated IP address ranges for this private service access connection.
  • address string: The starting address of the reserved range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix length is the CIDR range for the reserved range.
  • ipPrefixLength integer: The prefix length of the reserved range.
  • name string: The name of the reserved range.

GoogleCloudServicenetworkingV1betaSubnetwork

• GoogleCloudServicenetworkingV1betaSubnetwork object: Represents a subnet that was created or discovered by a private access management service.
  • ipCidrRange string: Subnetwork CIDR range in 10.x.x.x/y format.
  • name string: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/
  • network string: In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: projects/1234321/global/networks/host-network
  • outsideAllocation boolean: This is a discovered subnet that is not within the current consumer allocated ranges.

Http

• Http object: Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.
  • fullyDecodeReservedExpansion boolean: 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.
  • rules array: A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
    • items HttpRule

HttpRule

• HttpRule object: # 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, Cloud Endpoints, gRPC Gateway, and 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(messageid: "123456" text: "Hi!")Note that when usingin 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 ofis 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 theadditional_bindingsoption. 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. 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 is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If 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 syntaxmatches 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 theVerb. The syntaxVariablematches 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 syntaxLITERALmatches literal text in the URL path. If theLITERALcontains 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-Zare 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 thegoogle.api.Serviceproto 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 aHttpRule` 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. While the single segment variable follows the semantics of RFC 6570 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.
  • additionalBindings array: 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).
    • items HttpRule
  • body string: 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.
  • custom CustomHttpPattern
  • delete string: Maps to HTTP DELETE. Used for deleting a resource.
  • get string: Maps to HTTP GET. Used for listing and getting information about resources.
  • patch string: Maps to HTTP PATCH. Used for updating a resource.
  • post string: Maps to HTTP POST. Used for creating a resource or performing an action.
  • put string: Maps to HTTP PUT. Used for replacing a resource.
  • responseBody string: 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.
  • selector string: Selects a method to which this rule applies. Refer to selector for syntax details.

JwtLocation

• JwtLocation object: Specifies a location to extract JWT from an API request.
  • header string: Specifies HTTP header name to extract JWT token.
  • query string: Specifies URL query parameter name to extract JWT token.
  • valuePrefix string: The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

LabelDescriptor

• LabelDescriptor object: A description of a label.
  • description string: A human-readable description for the label.
  • key string: The label key.
  • valueType string (values: STRING, BOOL, INT64): The type of data that can be assigned to the label.

ListConnectionsResponse

• ListConnectionsResponse object: ListConnectionsResponse is the response to list peering states for the given service and consumer project.
  • connections array: The list of Connections.
    • items Connection

LogDescriptor

• LogDescriptor object: A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items. display_name: Activity labels: - key: /customer_id description: Identifier of a library customer
  • description string: A human-readable description of this log. This information appears in the documentation and can contain details.
  • displayName string: The human-readable name for this log. This information appears on the user interface and should be concise.
  • labels array: The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
    • items LabelDescriptor
  • name string: The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters A-Za-z0-9, and punctuation characters including slash, underscore, hyphen, period /_-..

Logging

• Logging object: Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the activity_history log is sent to both the producer and consumer projects, whereas the purchase_history log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history
  • consumerDestinations array: Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
    • items LoggingDestination
  • producerDestinations array: Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
    • items LoggingDestination

LoggingDestination

• LoggingDestination object: Configuration of a specific logging destination (the producer project or the consumer project).
  • logs array: Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
    • items string
  • monitoredResource string: The monitored resource type. The type must be defined in the Service.monitored_resources section.

Method

• Method object: Method represents a method of an API interface.
  • name string: The simple name of this method.
  • options array: Any metadata attached to the method.
    • items Option
  • requestStreaming boolean: If true, the request is streamed.
  • requestTypeUrl string: A URL of the input message type.
  • responseStreaming boolean: If true, the response is streamed.
  • responseTypeUrl string: The URL of the output message type.
  • syntax string (values: SYNTAX_PROTO2, SYNTAX_PROTO3): The source syntax of this method.

MetricDescriptor

• MetricDescriptor object: Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
  • description string: A detailed description of the metric, which can be used in documentation.
  • displayName string: A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
  • labels array: The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
    • items LabelDescriptor
  • launchStage string (values: LAUNCH_STAGE_UNSPECIFIED, UNIMPLEMENTED, PRELAUNCH, EARLY_ACCESS, ALPHA, BETA, GA, DEPRECATED): Optional. The launch stage of the metric definition.
  • metadata MetricDescriptorMetadata
  • metricKind string (values: METRIC_KIND_UNSPECIFIED, GAUGE, DELTA, CUMULATIVE): Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
  • monitoredResourceTypes array: Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
    • items string
  • name string: The resource name of the metric descriptor.
  • type string: The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"
  • unit string: The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionless Prefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50) Grammar The grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( PREFIX UNIT | "%" ) Annotation | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "n