Debian Codegraph @

servicenetworking/v1beta/servicenetworking-gen.go

raw
1 // Copyright 2026 Google LLC.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
4
5 // Code generated file. DO NOT EDIT.
6
7 // Package servicenetworking provides access to the Service Networking API.
8 //
9 // For product documentation, see: https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started
10 //
11 // # Library status
12 //
13 // These client libraries are officially supported by Google. However, this
14 // library is considered complete and is in maintenance mode. This means
15 // that we will address critical bugs and security issues but will not add
16 // any new features.
17 //
18 // When possible, we recommend using our newer
19 // [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)
20 // that are still actively being worked and iterated on.
21 //
22 // # Creating a client
23 //
24 // Usage example:
25 //
26 // import "google.golang.org/api/servicenetworking/v1beta"
27 // ...
28 // ctx := context.Background()
29 // servicenetworkingService, err := servicenetworking.NewService(ctx)
30 //
31 // In this example, Google Application Default Credentials are used for
32 // authentication. For information on how to create and obtain Application
33 // Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
34 //
35 // # Other authentication options
36 //
37 // By default, all available scopes (see "Constants") are used to authenticate.
38 // To restrict scopes, use [google.golang.org/api/option.WithScopes]:
39 //
40 // servicenetworkingService, err := servicenetworking.NewService(ctx, option.WithScopes(servicenetworking.ServiceManagementScope))
41 //
42 // To use an API key for authentication (note: some APIs do not support API
43 // keys), use [google.golang.org/api/option.WithAPIKey]:
44 //
45 // servicenetworkingService, err := servicenetworking.NewService(ctx, option.WithAPIKey("AIza..."))
46 //
47 // To use an OAuth token (e.g., a user token obtained via a three-legged OAuth
48 // flow, use [google.golang.org/api/option.WithTokenSource]:
49 //
50 // config := &oauth2.Config{...}
51 // // ...
52 // token, err := config.Exchange(ctx, ...)
53 // servicenetworkingService, err := servicenetworking.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
54 //
55 // See [google.golang.org/api/option.ClientOption] for details on options.
56 package servicenetworking // import "google.golang.org/api/servicenetworking/v1beta"
57
58 import (
59 "bytes"
60 "context"
61 "encoding/json"
62 "errors"
63 "fmt"
64 "io"
65 "log/slog"
66 "net/http"
67 "net/url"
68 "strconv"
69 "strings"
70
71 "github.com/googleapis/gax-go/v2/internallog"
72 googleapi "google.golang.org/api/googleapi"
73 internal "google.golang.org/api/internal"
74 gensupport "google.golang.org/api/internal/gensupport"
75 option "google.golang.org/api/option"
76 internaloption "google.golang.org/api/option/internaloption"
77 htransport "google.golang.org/api/transport/http"
78 )
79
80 // Always reference these packages, just in case the auto-generated code
81 // below doesn't.
82 var _ = bytes.NewBuffer
83 var _ = strconv.Itoa
84 var _ = fmt.Sprintf
85 var _ = json.NewDecoder
86 var _ = io.Copy
87 var _ = url.Parse
88 var _ = gensupport.MarshalJSON
89 var _ = googleapi.Version
90 var _ = errors.New
91 var _ = strings.Replace
92 var _ = context.Canceled
93 var _ = internaloption.WithDefaultEndpoint
94 var _ = internal.Version
95 var _ = internallog.New
96
97 const apiId = "servicenetworking:v1beta"
98 const apiName = "servicenetworking"
99 const apiVersion = "v1beta"
100 const basePath = "https://servicenetworking.googleapis.com/"
101 const basePathTemplate = "https://servicenetworking.UNIVERSE_DOMAIN/"
102 const mtlsBasePath = "https://servicenetworking.mtls.googleapis.com/"
103
104 // OAuth2 scopes used by this API.
105 const (
106 // See, edit, configure, and delete your Google Cloud data and see the email
107 // address for your Google Account.
108 CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
109
110 // Manage your Google API service configuration
111 ServiceManagementScope = "https://www.googleapis.com/auth/service.management"
112 )
113
114 // NewService creates a new APIService.
115 func NewService(ctx context.Context, opts ...option.ClientOption) (*APIService, error) {
116 scopesOption := internaloption.WithDefaultScopes(
117 "https://www.googleapis.com/auth/cloud-platform",
118 "https://www.googleapis.com/auth/service.management",
119 )
120 // NOTE: prepend, so we don't override user-specified scopes.
121 opts = append([]option.ClientOption{scopesOption}, opts...)
122 opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
123 opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))
124 opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
125 opts = append(opts, internaloption.EnableNewAuthLibrary())
126 client, endpoint, err := htransport.NewClient(ctx, opts...)
127 if err != nil {
128 return nil, err
129 }
130 s := &APIService{client: client, BasePath: basePath, logger: internaloption.GetLogger(opts)}
131 s.Operations = NewOperationsService(s)
132 s.Services = NewServicesService(s)
133 if endpoint != "" {
134 s.BasePath = endpoint
135 }
136 return s, nil
137 }
138
139 // New creates a new APIService. It uses the provided http.Client for requests.
140 //
141 // Deprecated: please use NewService instead.
142 // To provide a custom HTTP client, use option.WithHTTPClient.
143 // If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
144 func New(client *http.Client) (*APIService, error) {
145 if client == nil {
146 return nil, errors.New("client is nil")
147 }
148 return NewService(context.TODO(), option.WithHTTPClient(client))
149 }
150
151 type APIService struct {
152 client *http.Client
153 logger *slog.Logger
154 BasePath string // API endpoint base URL
155 UserAgent string // optional additional User-Agent fragment
156
157 Operations *OperationsService
158
159 Services *ServicesService
160 }
161
162 func (s *APIService) userAgent() string {
163 if s.UserAgent == "" {
164 return googleapi.UserAgent
165 }
166 return googleapi.UserAgent + " " + s.UserAgent
167 }
168
169 func NewOperationsService(s *APIService) *OperationsService {
170 rs := &OperationsService{s: s}
171 return rs
172 }
173
174 type OperationsService struct {
175 s *APIService
176 }
177
178 func NewServicesService(s *APIService) *ServicesService {
179 rs := &ServicesService{s: s}
180 rs.Connections = NewServicesConnectionsService(s)
181 return rs
182 }
183
184 type ServicesService struct {
185 s *APIService
186
187 Connections *ServicesConnectionsService
188 }
189
190 func NewServicesConnectionsService(s *APIService) *ServicesConnectionsService {
191 rs := &ServicesConnectionsService{s: s}
192 return rs
193 }
194
195 type ServicesConnectionsService struct {
196 s *APIService
197 }
198
199 // AddDnsRecordSetMetadata: Metadata provided through GetOperation request for
200 // the LRO generated by AddDnsRecordSet API
201 type AddDnsRecordSetMetadata struct {
202 }
203
204 // AddDnsZoneMetadata: Metadata provided through GetOperation request for the
205 // LRO generated by AddDnsZone API
206 type AddDnsZoneMetadata struct {
207 }
208
209 // AddDnsZoneResponse: Represents managed DNS zones created in the shared
210 // producer host and consumer projects.
211 type AddDnsZoneResponse struct {
212 // ConsumerPeeringZone: The DNS peering zone created in the consumer project.
213 ConsumerPeeringZone *DnsZone `json:"consumerPeeringZone,omitempty"`
214 // ProducerPrivateZone: The private DNS zone created in the shared producer
215 // host project.
216 ProducerPrivateZone *DnsZone `json:"producerPrivateZone,omitempty"`
217 // ForceSendFields is a list of field names (e.g. "ConsumerPeeringZone") to
218 // unconditionally include in API requests. By default, fields with empty or
219 // default values are omitted from API requests. See
220 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
221 // details.
222 ForceSendFields []string `json:"-"`
223 // NullFields is a list of field names (e.g. "ConsumerPeeringZone") to include
224 // in API requests with the JSON null value. By default, fields with empty
225 // values are omitted from API requests. See
226 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
227 NullFields []string `json:"-"`
228 }
229
230 func (s AddDnsZoneResponse) MarshalJSON() ([]byte, error) {
231 type NoMethod AddDnsZoneResponse
232 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
233 }
234
235 // AddRolesMetadata: Metadata provided through GetOperation request for the LRO
236 // generated by AddRoles API
237 type AddRolesMetadata struct {
238 }
239
240 // AddRolesResponse: Represents IAM roles added to the shared VPC host project.
241 type AddRolesResponse struct {
242 // PolicyBinding: Required. List of policy bindings that were added to the
243 // shared VPC host project.
244 PolicyBinding []*PolicyBinding `json:"policyBinding,omitempty"`
245 // ForceSendFields is a list of field names (e.g. "PolicyBinding") to
246 // unconditionally include in API requests. By default, fields with empty or
247 // default values are omitted from API requests. See
248 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
249 // details.
250 ForceSendFields []string `json:"-"`
251 // NullFields is a list of field names (e.g. "PolicyBinding") to include in API
252 // requests with the JSON null value. By default, fields with empty values are
253 // omitted from API requests. See
254 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
255 NullFields []string `json:"-"`
256 }
257
258 func (s AddRolesResponse) MarshalJSON() ([]byte, error) {
259 type NoMethod AddRolesResponse
260 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
261 }
262
263 // AddSubnetworkRequest: Request to create a subnetwork in a previously peered
264 // service network.
265 type AddSubnetworkRequest struct {
266 // Consumer: Required. A resource that represents the service consumer, such as
267 // `projects/123456`. The project number can be different from the value in the
268 // consumer network parameter. For example, the network might be part of a
269 // Shared VPC network. In those cases, Service Networking validates that this
270 // resource belongs to that Shared VPC.
271 Consumer string `json:"consumer,omitempty"`
272 // ConsumerNetwork: Required. The name of the service consumer's VPC network.
273 // The network must have an existing private connection that was provisioned
274 // through the connections.create method. The name must be in the following
275 // format: `projects/{project}/global/networks/{network}`, where {project} is a
276 // project number, such as `12345`. {network} is the name of a VPC network in
277 // the project.
278 ConsumerNetwork string `json:"consumerNetwork,omitempty"`
279 // Description: An optional description of the subnet.
280 Description string `json:"description,omitempty"`
281 // IpPrefixLength: Required. The prefix length of the subnet's IP address
282 // range. Use CIDR range notation, such as `30` to provision a subnet with an
283 // `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of
284 // available ranges in the service consumer's allocated range.
285 IpPrefixLength int64 `json:"ipPrefixLength,omitempty"`
286 // Region: Required. The name of a region (/compute/docs/regions-zones) for the
287 // subnet, such `europe-west1`.
288 Region string `json:"region,omitempty"`
289 // RequestedAddress: Optional. The starting address of a range. The address
290 // must be a valid IPv4 address in the x.x.x.x format. This value combined with
291 // the IP prefix range is the CIDR range for the subnet. The range must be
292 // within the allocated range that is assigned to the private connection. If
293 // the CIDR range isn't available, the call fails.
294 RequestedAddress string `json:"requestedAddress,omitempty"`
295 // Subnetwork: Required. A name for the new subnet. For information about the
296 // naming requirements, see subnetwork
297 // (/compute/docs/reference/rest/v1/subnetworks) in the Compute API
298 // documentation.
299 Subnetwork string `json:"subnetwork,omitempty"`
300 // SubnetworkUsers: A list of members that are granted the
301 // `compute.networkUser` role on the subnet.
302 SubnetworkUsers []string `json:"subnetworkUsers,omitempty"`
303 // ForceSendFields is a list of field names (e.g. "Consumer") to
304 // unconditionally include in API requests. By default, fields with empty or
305 // default values are omitted from API requests. See
306 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
307 // details.
308 ForceSendFields []string `json:"-"`
309 // NullFields is a list of field names (e.g. "Consumer") to include in API
310 // requests with the JSON null value. By default, fields with empty values are
311 // omitted from API requests. See
312 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
313 NullFields []string `json:"-"`
314 }
315
316 func (s AddSubnetworkRequest) MarshalJSON() ([]byte, error) {
317 type NoMethod AddSubnetworkRequest
318 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
319 }
320
321 // Api: Api is a light-weight descriptor for an API Interface. Interfaces are
322 // also described as "protocol buffer services" in some contexts, such as by
323 // the "service" keyword in a .proto file, but they are different from API
324 // Services, which represent a concrete implementation of an interface as
325 // opposed to simply a description of methods and bindings. They are also
326 // sometimes simply referred to as "APIs" in other contexts, such as the name
327 // of this message itself. See https://cloud.google.com/apis/design/glossary
328 // for detailed terminology. New usages of this message as an alternative to
329 // ServiceDescriptorProto are strongly discouraged. This message does not
330 // reliability preserve all information necessary to model the schema and
331 // preserve semantics. Instead make use of FileDescriptorSet which preserves
332 // the necessary information.
333 type Api struct {
334 // Edition: The source edition string, only valid when syntax is
335 // SYNTAX_EDITIONS.
336 Edition string `json:"edition,omitempty"`
337 // Methods: The methods of this interface, in unspecified order.
338 Methods []*Method `json:"methods,omitempty"`
339 // Mixins: Included interfaces. See Mixin.
340 Mixins []*Mixin `json:"mixins,omitempty"`
341 // Name: The fully qualified name of this interface, including package name
342 // followed by the interface's simple name.
343 Name string `json:"name,omitempty"`
344 // Options: Any metadata attached to the interface.
345 Options []*Option `json:"options,omitempty"`
346 // SourceContext: Source context for the protocol buffer service represented by
347 // this message.
348 SourceContext *SourceContext `json:"sourceContext,omitempty"`
349 // Syntax: The source syntax of the service.
350 //
351 // Possible values:
352 // "SYNTAX_PROTO2" - Syntax `proto2`.
353 // "SYNTAX_PROTO3" - Syntax `proto3`.
354 // "SYNTAX_EDITIONS" - Syntax `editions`.
355 Syntax string `json:"syntax,omitempty"`
356 // Version: A version string for this interface. If specified, must have the
357 // form `major-version.minor-version`, as in `1.10`. If the minor version is
358 // omitted, it defaults to zero. If the entire version field is empty, the
359 // major version is derived from the package name, as outlined below. If the
360 // field is not empty, the version in the package name will be verified to be
361 // consistent with what is provided here. The versioning schema uses semantic
362 // versioning (http://semver.org) where the major version number indicates a
363 // breaking change and the minor version an additive, non-breaking change. Both
364 // version numbers are signals to users what to expect from different versions,
365 // and should be carefully chosen based on the product plan. The major version
366 // is also reflected in the package name of the interface, which must end in
367 // `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can
368 // be omitted. Zero major versions must only be used for experimental, non-GA
369 // interfaces.
370 Version string `json:"version,omitempty"`
371 // ForceSendFields is a list of field names (e.g. "Edition") to unconditionally
372 // include in API requests. By default, fields with empty or default values are
373 // omitted from API requests. See
374 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
375 // details.
376 ForceSendFields []string `json:"-"`
377 // NullFields is a list of field names (e.g. "Edition") to include in API
378 // requests with the JSON null value. By default, fields with empty values are
379 // omitted from API requests. See
380 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
381 NullFields []string `json:"-"`
382 }
383
384 func (s Api) MarshalJSON() ([]byte, error) {
385 type NoMethod Api
386 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
387 }
388
389 // Aspect: Aspect represents Generic aspect. It is used to configure an aspect
390 // without making direct changes to service.proto
391 type Aspect struct {
392 // Kind: The type of this aspect configuration.
393 Kind string `json:"kind,omitempty"`
394 // Rules: Optional. Rules of the Configuration.
395 Rules []*AspectRule `json:"rules,omitempty"`
396 // Spec: Content of the configuration. The underlying schema should be defined
397 // by Aspect owners as protobuf message under `google/api/configaspects/proto`.
398 Spec googleapi.RawMessage `json:"spec,omitempty"`
399 // ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
400 // include in API requests. By default, fields with empty or default values are
401 // omitted from API requests. See
402 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
403 // details.
404 ForceSendFields []string `json:"-"`
405 // NullFields is a list of field names (e.g. "Kind") to include in API requests
406 // with the JSON null value. By default, fields with empty values are omitted
407 // from API requests. See
408 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
409 NullFields []string `json:"-"`
410 }
411
412 func (s Aspect) MarshalJSON() ([]byte, error) {
413 type NoMethod Aspect
414 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
415 }
416
417 // AspectRule: Rule-based configuration for an aspect.
418 type AspectRule struct {
419 // Config: Required. Rules of the configuration. The underlying schema should
420 // be defined by Aspect owners as protobuf message under
421 // `google/api/configaspects/proto`.
422 Config googleapi.RawMessage `json:"config,omitempty"`
423 // Selector: Required. Selects the RPC methods to which this rule applies.
424 // Refer to selector for syntax details.
425 Selector string `json:"selector,omitempty"`
426 // ForceSendFields is a list of field names (e.g. "Config") to unconditionally
427 // include in API requests. By default, fields with empty or default values are
428 // omitted from API requests. See
429 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
430 // details.
431 ForceSendFields []string `json:"-"`
432 // NullFields is a list of field names (e.g. "Config") to include in API
433 // requests with the JSON null value. By default, fields with empty values are
434 // omitted from API requests. See
435 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
436 NullFields []string `json:"-"`
437 }
438
439 func (s AspectRule) MarshalJSON() ([]byte, error) {
440 type NoMethod AspectRule
441 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
442 }
443
444 // AuthProvider: Configuration for an authentication provider, including
445 // support for JSON Web Token (JWT)
446 // (https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
447 type AuthProvider struct {
448 // Audiences: The list of JWT audiences
449 // (https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
450 // that are allowed to access. A JWT containing any of these audiences will be
451 // accepted. When this setting is absent, JWTs with audiences: -
452 // "https://[service.name]/[google.protobuf.Api.name]" -
453 // "https://[service.name]/" will be accepted. For example, if no audiences are
454 // in the setting, LibraryService API will accept JWTs with the following
455 // audiences: -
456 // https://library-example.googleapis.com/google.example.library.v1.LibraryService
457 // - https://library-example.googleapis.com/ Example: audiences:
458 // bookstore_android.apps.googleusercontent.com,
459 // bookstore_web.apps.googleusercontent.com
460 Audiences string `json:"audiences,omitempty"`
461 // AuthorizationUrl: Redirect URL if JWT token is required but not present or
462 // is expired. Implement authorizationUrl of securityDefinitions in OpenAPI
463 // spec.
464 AuthorizationUrl string `json:"authorizationUrl,omitempty"`
465 // Id: The unique identifier of the auth provider. It will be referred to by
466 // `AuthRequirement.provider_id`. Example: "bookstore_auth".
467 Id string `json:"id,omitempty"`
468 // Issuer: Identifies the principal that issued the JWT. See
469 // https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
470 // Usually a URL or an email address. Example: https://securetoken.google.com
471 // Example: [email protected]
472 Issuer string `json:"issuer,omitempty"`
473 // JwksUri: URL of the provider's public key set to validate signature of the
474 // JWT. See OpenID Discovery
475 // (https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
476 // Optional if the key set document: - can be retrieved from OpenID Discovery
477 // (https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer.
478 // - can be inferred from the email domain of the issuer (e.g. a Google service
479 // account). Example: https://www.googleapis.com/oauth2/v1/certs
480 JwksUri string `json:"jwksUri,omitempty"`
481 // JwtLocations: Defines the locations to extract the JWT. For now it is only
482 // used by the Cloud Endpoints to store the OpenAPI extension
483 // [x-google-jwt-locations]
484 // (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations)
485 // JWT locations can be one of HTTP headers, URL query parameters or cookies.
486 // The rule is that the first match wins. If not specified, default to use
487 // following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion
488 // 3) access_token query parameter Default locations can be specified as
489 // followings: jwt_locations: - header: Authorization value_prefix: "Bearer " -
490 // header: x-goog-iap-jwt-assertion - query: access_token
491 JwtLocations []*JwtLocation `json:"jwtLocations,omitempty"`
492 // ForceSendFields is a list of field names (e.g. "Audiences") to
493 // unconditionally include in API requests. By default, fields with empty or
494 // default values are omitted from API requests. See
495 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
496 // details.
497 ForceSendFields []string `json:"-"`
498 // NullFields is a list of field names (e.g. "Audiences") to include in API
499 // requests with the JSON null value. By default, fields with empty values are
500 // omitted from API requests. See
501 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
502 NullFields []string `json:"-"`
503 }
504
505 func (s AuthProvider) MarshalJSON() ([]byte, error) {
506 type NoMethod AuthProvider
507 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
508 }
509
510 // AuthRequirement: User-defined authentication requirements, including support
511 // for JSON Web Token (JWT)
512 // (https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
513 type AuthRequirement struct {
514 // Audiences: NOTE: This will be deprecated soon, once AuthProvider.audiences
515 // is implemented and accepted in all the runtime components. The list of JWT
516 // audiences
517 // (https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
518 // that are allowed to access. A JWT containing any of these audiences will be
519 // accepted. When this setting is absent, only JWTs with audience
520 // "https://Service_name/API_name" will be accepted. For example, if no
521 // audiences are in the setting, LibraryService API will only accept JWTs with
522 // the following audience
523 // "https://library-example.googleapis.com/google.example.library.v1.LibraryServ
524 // ice". Example: audiences: bookstore_android.apps.googleusercontent.com,
525 // bookstore_web.apps.googleusercontent.com
526 Audiences string `json:"audiences,omitempty"`
527 // ProviderId: id from authentication provider. Example: provider_id:
528 // bookstore_auth
529 ProviderId string `json:"providerId,omitempty"`
530 // ForceSendFields is a list of field names (e.g. "Audiences") to
531 // unconditionally include in API requests. By default, fields with empty or
532 // default values are omitted from API requests. See
533 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
534 // details.
535 ForceSendFields []string `json:"-"`
536 // NullFields is a list of field names (e.g. "Audiences") to include in API
537 // requests with the JSON null value. By default, fields with empty values are
538 // omitted from API requests. See
539 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
540 NullFields []string `json:"-"`
541 }
542
543 func (s AuthRequirement) MarshalJSON() ([]byte, error) {
544 type NoMethod AuthRequirement
545 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
546 }
547
548 // Authentication: `Authentication` defines the authentication configuration
549 // for API methods provided by an API service. Example: name:
550 // calendar.googleapis.com authentication: providers: - id:
551 // google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs
552 // issuer: https://securetoken.google.com rules: - selector: "*" requirements:
553 // provider_id: google_calendar_auth - selector: google.calendar.Delegate
554 // oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read
555 type Authentication struct {
556 // Providers: Defines a set of authentication providers that a service
557 // supports.
558 Providers []*AuthProvider `json:"providers,omitempty"`
559 // Rules: A list of authentication rules that apply to individual API methods.
560 // **NOTE:** All service configuration rules follow "last one wins" order.
561 Rules []*AuthenticationRule `json:"rules,omitempty"`
562 // ForceSendFields is a list of field names (e.g. "Providers") to
563 // unconditionally include in API requests. By default, fields with empty or
564 // default values are omitted from API requests. See
565 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
566 // details.
567 ForceSendFields []string `json:"-"`
568 // NullFields is a list of field names (e.g. "Providers") to include in API
569 // requests with the JSON null value. By default, fields with empty values are
570 // omitted from API requests. See
571 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
572 NullFields []string `json:"-"`
573 }
574
575 func (s Authentication) MarshalJSON() ([]byte, error) {
576 type NoMethod Authentication
577 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
578 }
579
580 // AuthenticationRule: Authentication rules for the service. By default, if a
581 // method has any authentication requirements, every request must include a
582 // valid credential matching one of the requirements. It's an error to include
583 // more than one kind of credential in a single request. If a method doesn't
584 // have any auth requirements, request credentials will be ignored.
585 type AuthenticationRule struct {
586 // AllowWithoutCredential: If true, the service accepts API keys without any
587 // other credential. This flag only applies to HTTP and gRPC requests.
588 AllowWithoutCredential bool `json:"allowWithoutCredential,omitempty"`
589 // Oauth: The requirements for OAuth credentials.
590 Oauth *OAuthRequirements `json:"oauth,omitempty"`
591 // Requirements: Requirements for additional authentication providers.
592 Requirements []*AuthRequirement `json:"requirements,omitempty"`
593 // Selector: Selects the methods to which this rule applies. Refer to selector
594 // for syntax details.
595 Selector string `json:"selector,omitempty"`
596 // ForceSendFields is a list of field names (e.g. "AllowWithoutCredential") to
597 // unconditionally include in API requests. By default, fields with empty or
598 // default values are omitted from API requests. See
599 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
600 // details.
601 ForceSendFields []string `json:"-"`
602 // NullFields is a list of field names (e.g. "AllowWithoutCredential") to
603 // include in API requests with the JSON null value. By default, fields with
604 // empty values are omitted from API requests. See
605 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
606 NullFields []string `json:"-"`
607 }
608
609 func (s AuthenticationRule) MarshalJSON() ([]byte, error) {
610 type NoMethod AuthenticationRule
611 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
612 }
613
614 // Backend: `Backend` defines the backend configuration for a service.
615 type Backend struct {
616 // Rules: A list of API backend rules that apply to individual API methods.
617 // **NOTE:** All service configuration rules follow "last one wins" order.
618 Rules []*BackendRule `json:"rules,omitempty"`
619 // ForceSendFields is a list of field names (e.g. "Rules") to unconditionally
620 // include in API requests. By default, fields with empty or default values are
621 // omitted from API requests. See
622 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
623 // details.
624 ForceSendFields []string `json:"-"`
625 // NullFields is a list of field names (e.g. "Rules") to include in API
626 // requests with the JSON null value. By default, fields with empty values are
627 // omitted from API requests. See
628 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
629 NullFields []string `json:"-"`
630 }
631
632 func (s Backend) MarshalJSON() ([]byte, error) {
633 type NoMethod Backend
634 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
635 }
636
637 // BackendRule: A backend rule provides configuration for an individual API
638 // element.
639 type BackendRule struct {
640 // Address: The address of the API backend. The scheme is used to determine the
641 // backend protocol and security. The following schemes are accepted: SCHEME
642 // PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None
643 // grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving
644 // out the scheme may cause constrasting behaviors across platforms. If the
645 // port is unspecified, the default is: - 80 for schemes without TLS - 443 for
646 // schemes with TLS For HTTP backends, use protocol to specify the protocol
647 // version.
648 Address string `json:"address,omitempty"`
649 // Deadline: The number of seconds to wait for a response from a request. The
650 // default varies based on the request protocol and deployment environment.
651 Deadline float64 `json:"deadline,omitempty"`
652 // DisableAuth: When disable_auth is true, a JWT ID token won't be generated
653 // and the original "Authorization" HTTP header will be preserved. If the
654 // header is used to carry the original token and is expected by the backend,
655 // this field must be set to true to preserve the header.
656 DisableAuth bool `json:"disableAuth,omitempty"`
657 // JwtAudience: The JWT audience is used when generating a JWT ID token for the
658 // backend. This ID token will be added in the HTTP "authorization" header, and
659 // sent to the backend.
660 JwtAudience string `json:"jwtAudience,omitempty"`
661 // LoadBalancingPolicy: The load balancing policy used for connection to the
662 // application backend. Defined as an arbitrary string to accomondate custom
663 // load balancing policies supported by the underlying channel, but suggest
664 // most users use one of the standard policies, such as the default,
665 // "RoundRobin".
666 LoadBalancingPolicy string `json:"loadBalancingPolicy,omitempty"`
667 // MinDeadline: Deprecated, do not use.
668 MinDeadline float64 `json:"minDeadline,omitempty"`
669 // OperationDeadline: The number of seconds to wait for the completion of a
670 // long running operation. The default is no deadline.
671 OperationDeadline float64 `json:"operationDeadline,omitempty"`
672 // OverridesByRequestProtocol: The map between request protocol and the backend
673 // address.
674 OverridesByRequestProtocol map[string]BackendRule `json:"overridesByRequestProtocol,omitempty"`
675 // PathTranslation: Path translation specifies how to combine the backend
676 // address with the request path in order to produce the appropriate forwarding
677 // URL for the request. See PathTranslation for more details.
678 //
679 // Possible values:
680 // "PATH_TRANSLATION_UNSPECIFIED"
681 // "CONSTANT_ADDRESS" - Use the backend address as-is, with no modification
682 // to the path. If the URL pattern contains variables, the variable names and
683 // values will be appended to the query string. If a query string parameter and
684 // a URL pattern variable have the same name, this may result in duplicate keys
685 // in the query string. # Examples Given the following operation config: Method
686 // path: /api/company/{cid}/user/{uid} Backend address:
687 // https://example.cloudfunctions.net/getUser Requests to the following request
688 // paths will call the backend at the translated path: Request path:
689 // /api/company/widgetworks/user/johndoe Translated:
690 // https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe
691 // Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated:
692 // https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe
693 // "APPEND_PATH_TO_ADDRESS" - The request path will be appended to the
694 // backend address. # Examples Given the following operation config: Method
695 // path: /api/company/{cid}/user/{uid} Backend address:
696 // https://example.appspot.com Requests to the following request paths will
697 // call the backend at the translated path: Request path:
698 // /api/company/widgetworks/user/johndoe Translated:
699 // https://example.appspot.com/api/company/widgetworks/user/johndoe Request
700 // path: /api/company/widgetworks/user/johndoe?timezone=EST Translated:
701 // https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST
702 PathTranslation string `json:"pathTranslation,omitempty"`
703 // Protocol: The protocol used for sending a request to the backend. The
704 // supported values are "http/1.1" and "h2". The default value is inferred from
705 // the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https://
706 // http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that
707 // support HTTP/2, set this field to "h2" for improved performance. Configuring
708 // this field to non-default values is only supported for secure HTTP backends.
709 // This field will be ignored for all other backends. See
710 // https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
711 // for more details on the supported values.
712 Protocol string `json:"protocol,omitempty"`
713 // Selector: Selects the methods to which this rule applies. Refer to selector
714 // for syntax details.
715 Selector string `json:"selector,omitempty"`
716 // ForceSendFields is a list of field names (e.g. "Address") to unconditionally
717 // include in API requests. By default, fields with empty or default values are
718 // omitted from API requests. See
719 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
720 // details.
721 ForceSendFields []string `json:"-"`
722 // NullFields is a list of field names (e.g. "Address") to include in API
723 // requests with the JSON null value. By default, fields with empty values are
724 // omitted from API requests. See
725 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
726 NullFields []string `json:"-"`
727 }
728
729 func (s BackendRule) MarshalJSON() ([]byte, error) {
730 type NoMethod BackendRule
731 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
732 }
733
734 func (s *BackendRule) UnmarshalJSON(data []byte) error {
735 type NoMethod BackendRule
736 var s1 struct {
737 Deadline gensupport.JSONFloat64 `json:"deadline"`
738 MinDeadline gensupport.JSONFloat64 `json:"minDeadline"`
739 OperationDeadline gensupport.JSONFloat64 `json:"operationDeadline"`
740 *NoMethod
741 }
742 s1.NoMethod = (*NoMethod)(s)
743 if err := json.Unmarshal(data, &s1); err != nil {
744 return err
745 }
746 s.Deadline = float64(s1.Deadline)
747 s.MinDeadline = float64(s1.MinDeadline)
748 s.OperationDeadline = float64(s1.OperationDeadline)
749 return nil
750 }
751
752 // BatchingConfigProto: `BatchingConfigProto` defines the batching
753 // configuration for an API method.
754 type BatchingConfigProto struct {
755 // BatchDescriptor: The request and response fields used in batching.
756 BatchDescriptor *BatchingDescriptorProto `json:"batchDescriptor,omitempty"`
757 // Thresholds: The thresholds which trigger a batched request to be sent.
758 Thresholds *BatchingSettingsProto `json:"thresholds,omitempty"`
759 // ForceSendFields is a list of field names (e.g. "BatchDescriptor") to
760 // unconditionally include in API requests. By default, fields with empty or
761 // default values are omitted from API requests. See
762 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
763 // details.
764 ForceSendFields []string `json:"-"`
765 // NullFields is a list of field names (e.g. "BatchDescriptor") to include in
766 // API requests with the JSON null value. By default, fields with empty values
767 // are omitted from API requests. See
768 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
769 NullFields []string `json:"-"`
770 }
771
772 func (s BatchingConfigProto) MarshalJSON() ([]byte, error) {
773 type NoMethod BatchingConfigProto
774 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
775 }
776
777 // BatchingDescriptorProto: `BatchingDescriptorProto` specifies the fields of
778 // the request message to be used for batching, and, optionally, the fields of
779 // the response message to be used for demultiplexing.
780 type BatchingDescriptorProto struct {
781 // BatchedField: The repeated field in the request message to be aggregated by
782 // batching.
783 BatchedField string `json:"batchedField,omitempty"`
784 // DiscriminatorFields: A list of the fields in the request message. Two
785 // requests will be batched together only if the values of every field
786 // specified in `request_discriminator_fields` is equal between the two
787 // requests.
788 DiscriminatorFields []string `json:"discriminatorFields,omitempty"`
789 // SubresponseField: Optional. When present, indicates the field in the
790 // response message to be used to demultiplex the response into multiple
791 // response messages, in correspondence with the multiple request messages
792 // originally batched together.
793 SubresponseField string `json:"subresponseField,omitempty"`
794 // ForceSendFields is a list of field names (e.g. "BatchedField") to
795 // unconditionally include in API requests. By default, fields with empty or
796 // default values are omitted from API requests. See
797 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
798 // details.
799 ForceSendFields []string `json:"-"`
800 // NullFields is a list of field names (e.g. "BatchedField") to include in API
801 // requests with the JSON null value. By default, fields with empty values are
802 // omitted from API requests. See
803 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
804 NullFields []string `json:"-"`
805 }
806
807 func (s BatchingDescriptorProto) MarshalJSON() ([]byte, error) {
808 type NoMethod BatchingDescriptorProto
809 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
810 }
811
812 // BatchingSettingsProto: `BatchingSettingsProto` specifies a set of batching
813 // thresholds, each of which acts as a trigger to send a batch of messages as a
814 // request. At least one threshold must be positive nonzero.
815 type BatchingSettingsProto struct {
816 // DelayThreshold: The duration after which a batch should be sent, starting
817 // from the addition of the first message to that batch.
818 DelayThreshold string `json:"delayThreshold,omitempty"`
819 // ElementCountLimit: The maximum number of elements collected in a batch that
820 // could be accepted by server.
821 ElementCountLimit int64 `json:"elementCountLimit,omitempty"`
822 // ElementCountThreshold: The number of elements of a field collected into a
823 // batch which, if exceeded, causes the batch to be sent.
824 ElementCountThreshold int64 `json:"elementCountThreshold,omitempty"`
825 // FlowControlByteLimit: The maximum size of data allowed by flow control.
826 FlowControlByteLimit int64 `json:"flowControlByteLimit,omitempty"`
827 // FlowControlElementLimit: The maximum number of elements allowed by flow
828 // control.
829 FlowControlElementLimit int64 `json:"flowControlElementLimit,omitempty"`
830 // FlowControlLimitExceededBehavior: The behavior to take when the flow control
831 // limit is exceeded.
832 //
833 // Possible values:
834 // "UNSET_BEHAVIOR" - Default behavior, system-defined.
835 // "THROW_EXCEPTION" - Stop operation, raise error.
836 // "BLOCK" - Pause operation until limit clears.
837 // "IGNORE" - Continue operation, disregard limit.
838 FlowControlLimitExceededBehavior string `json:"flowControlLimitExceededBehavior,omitempty"`
839 // RequestByteLimit: The maximum size of the request that could be accepted by
840 // server.
841 RequestByteLimit int64 `json:"requestByteLimit,omitempty"`
842 // RequestByteThreshold: The aggregated size of the batched field which, if
843 // exceeded, causes the batch to be sent. This size is computed by aggregating
844 // the sizes of the request field to be batched, not of the entire request
845 // message.
846 RequestByteThreshold int64 `json:"requestByteThreshold,omitempty,string"`
847 // ForceSendFields is a list of field names (e.g. "DelayThreshold") to
848 // unconditionally include in API requests. By default, fields with empty or
849 // default values are omitted from API requests. See
850 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
851 // details.
852 ForceSendFields []string `json:"-"`
853 // NullFields is a list of field names (e.g. "DelayThreshold") to include in
854 // API requests with the JSON null value. By default, fields with empty values
855 // are omitted from API requests. See
856 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
857 NullFields []string `json:"-"`
858 }
859
860 func (s BatchingSettingsProto) MarshalJSON() ([]byte, error) {
861 type NoMethod BatchingSettingsProto
862 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
863 }
864
865 // Billing: Billing related configuration of the service. The following example
866 // shows how to configure monitored resources and metrics for billing,
867 // `consumer_destinations` is the only supported destination and the monitored
868 // resources need at least one label key `cloud.googleapis.com/location` to
869 // indicate the location of the billing usage, using different monitored
870 // resources between monitoring and billing is recommended so they can be
871 // evolved independently: monitored_resources: - type:
872 // library.googleapis.com/billing_branch labels: - key:
873 // cloud.googleapis.com/location description: | Predefined label to support
874 // billing location restriction. - key: city description: | Custom label to
875 // define the city where the library branch is located in. - key: name
876 // description: Custom label to define the name of the library branch. metrics:
877 // - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA
878 // value_type: INT64 unit: "1" billing: consumer_destinations: -
879 // monitored_resource: library.googleapis.com/billing_branch metrics: -
880 // library.googleapis.com/book/borrowed_count
881 type Billing struct {
882 // ConsumerDestinations: Billing configurations for sending metrics to the
883 // consumer project. There can be multiple consumer destinations per service,
884 // each one must have a different monitored resource type. A metric can be used
885 // in at most one consumer destination.
886 ConsumerDestinations []*BillingDestination `json:"consumerDestinations,omitempty"`
887 // ForceSendFields is a list of field names (e.g. "ConsumerDestinations") to
888 // unconditionally include in API requests. By default, fields with empty or
889 // default values are omitted from API requests. See
890 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
891 // details.
892 ForceSendFields []string `json:"-"`
893 // NullFields is a list of field names (e.g. "ConsumerDestinations") to include
894 // in API requests with the JSON null value. By default, fields with empty
895 // values are omitted from API requests. See
896 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
897 NullFields []string `json:"-"`
898 }
899
900 func (s Billing) MarshalJSON() ([]byte, error) {
901 type NoMethod Billing
902 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
903 }
904
905 // BillingDestination: Configuration of a specific billing destination
906 // (Currently only support bill against consumer project).
907 type BillingDestination struct {
908 // Metrics: Names of the metrics to report to this billing destination. Each
909 // name must be defined in Service.metrics section.
910 Metrics []string `json:"metrics,omitempty"`
911 // MonitoredResource: The monitored resource type. The type must be defined in
912 // Service.monitored_resources section.
913 MonitoredResource string `json:"monitoredResource,omitempty"`
914 // ForceSendFields is a list of field names (e.g. "Metrics") to unconditionally
915 // include in API requests. By default, fields with empty or default values are
916 // omitted from API requests. See
917 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
918 // details.
919 ForceSendFields []string `json:"-"`
920 // NullFields is a list of field names (e.g. "Metrics") to include in API
921 // requests with the JSON null value. By default, fields with empty values are
922 // omitted from API requests. See
923 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
924 NullFields []string `json:"-"`
925 }
926
927 func (s BillingDestination) MarshalJSON() ([]byte, error) {
928 type NoMethod BillingDestination
929 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
930 }
931
932 // CleanupConnectionMetadata: Metadata provided through GetOperation request
933 // for the LRO generated by Cleanup Connection API
934 type CleanupConnectionMetadata struct {
935 }
936
937 // ClientLibrarySettings: Details about how and where to publish client
938 // libraries.
939 type ClientLibrarySettings struct {
940 // CppSettings: Settings for C++ client libraries.
941 CppSettings *CppSettings `json:"cppSettings,omitempty"`
942 // DotnetSettings: Settings for .NET client libraries.
943 DotnetSettings *DotnetSettings `json:"dotnetSettings,omitempty"`
944 // GoSettings: Settings for Go client libraries.
945 GoSettings *GoSettings `json:"goSettings,omitempty"`
946 // JavaSettings: Settings for legacy Java features, supported in the Service
947 // YAML.
948 JavaSettings *JavaSettings `json:"javaSettings,omitempty"`
949 // LaunchStage: Launch stage of this version of the API.
950 //
951 // Possible values:
952 // "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.
953 // "UNIMPLEMENTED" - The feature is not yet implemented. Users can not use
954 // it.
955 // "PRELAUNCH" - Prelaunch features are hidden from users and are only
956 // visible internally.
957 // "EARLY_ACCESS" - Early Access features are limited to a closed group of
958 // testers. To use these features, you must sign up in advance and sign a
959 // Trusted Tester agreement (which includes confidentiality provisions). These
960 // features may be unstable, changed in backward-incompatible ways, and are not
961 // guaranteed to be released.
962 // "ALPHA" - Alpha is a limited availability test for releases before they
963 // are cleared for widespread use. By Alpha, all significant design issues are
964 // resolved and we are in the process of verifying functionality. Alpha
965 // customers need to apply for access, agree to applicable terms, and have
966 // their projects allowlisted. Alpha releases don't have to be feature
967 // complete, no SLAs are provided, and there are no technical support
968 // obligations, but they will be far enough along that customers can actually
969 // use them in test environments or for limited-use tests -- just like they
970 // would in normal production cases.
971 // "BETA" - Beta is the point at which we are ready to open a release for any
972 // customer to use. There are no SLA or technical support obligations in a Beta
973 // release. Products will be complete from a feature perspective, but may have
974 // some open outstanding issues. Beta releases are suitable for limited
975 // production use cases.
976 // "GA" - GA features are open to all developers and are considered stable
977 // and fully qualified for production use.
978 // "DEPRECATED" - Deprecated features are scheduled to be shut down and
979 // removed. For more information, see the "Deprecation Policy" section of our
980 // [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud
981 // Platform Subject to the Deprecation
982 // Policy](https://cloud.google.com/terms/deprecation) documentation.
983 LaunchStage string `json:"launchStage,omitempty"`
984 // NodeSettings: Settings for Node client libraries.
985 NodeSettings *NodeSettings `json:"nodeSettings,omitempty"`
986 // PhpSettings: Settings for PHP client libraries.
987 PhpSettings *PhpSettings `json:"phpSettings,omitempty"`
988 // PythonSettings: Settings for Python client libraries.
989 PythonSettings *PythonSettings `json:"pythonSettings,omitempty"`
990 // RestNumericEnums: When using transport=rest, the client request will encode
991 // enums as numbers rather than strings.
992 RestNumericEnums bool `json:"restNumericEnums,omitempty"`
993 // RubySettings: Settings for Ruby client libraries.
994 RubySettings *RubySettings `json:"rubySettings,omitempty"`
995 // Version: Version of the API to apply these settings to. This is the full
996 // protobuf package for the API, ending in the version element. Examples:
997 // "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
998 Version string `json:"version,omitempty"`
999 // ForceSendFields is a list of field names (e.g. "CppSettings") to
1000 // unconditionally include in API requests. By default, fields with empty or
1001 // default values are omitted from API requests. See
1002 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1003 // details.
1004 ForceSendFields []string `json:"-"`
1005 // NullFields is a list of field names (e.g. "CppSettings") to include in API
1006 // requests with the JSON null value. By default, fields with empty values are
1007 // omitted from API requests. See
1008 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1009 NullFields []string `json:"-"`
1010 }
1011
1012 func (s ClientLibrarySettings) MarshalJSON() ([]byte, error) {
1013 type NoMethod ClientLibrarySettings
1014 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1015 }
1016
1017 // CloudSQLConfig: Cloud SQL configuration.
1018 type CloudSQLConfig struct {
1019 // Service: Required. Peering service used for peering with the Cloud SQL
1020 // project.
1021 Service string `json:"service,omitempty"`
1022 // UmbrellaNetwork: Required. The name of the umbrella network in the Cloud SQL
1023 // umbrella project.
1024 UmbrellaNetwork string `json:"umbrellaNetwork,omitempty"`
1025 // UmbrellaProject: Required. The project number of the Cloud SQL umbrella
1026 // project.
1027 UmbrellaProject int64 `json:"umbrellaProject,omitempty,string"`
1028 // ForceSendFields is a list of field names (e.g. "Service") to unconditionally
1029 // include in API requests. By default, fields with empty or default values are
1030 // omitted from API requests. See
1031 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1032 // details.
1033 ForceSendFields []string `json:"-"`
1034 // NullFields is a list of field names (e.g. "Service") to include in API
1035 // requests with the JSON null value. By default, fields with empty values are
1036 // omitted from API requests. See
1037 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1038 NullFields []string `json:"-"`
1039 }
1040
1041 func (s CloudSQLConfig) MarshalJSON() ([]byte, error) {
1042 type NoMethod CloudSQLConfig
1043 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1044 }
1045
1046 // CommonLanguageSettings: Required information for every language.
1047 type CommonLanguageSettings struct {
1048 // Destinations: The destination where API teams want this client library to be
1049 // published.
1050 //
1051 // Possible values:
1052 // "CLIENT_LIBRARY_DESTINATION_UNSPECIFIED" - Client libraries will neither
1053 // be generated nor published to package managers.
1054 // "GITHUB" - Generate the client library in a repo under
1055 // github.com/googleapis, but don't publish it to package managers.
1056 // "PACKAGE_MANAGER" - Publish the library to package managers like nuget.org
1057 // and npmjs.com.
1058 Destinations []string `json:"destinations,omitempty"`
1059 // ReferenceDocsUri: Link to automatically generated reference documentation.
1060 // Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
1061 ReferenceDocsUri string `json:"referenceDocsUri,omitempty"`
1062 // SelectiveGapicGeneration: Configuration for which RPCs should be generated
1063 // in the GAPIC client. Note: This field should not be used in most cases.
1064 SelectiveGapicGeneration *SelectiveGapicGeneration `json:"selectiveGapicGeneration,omitempty"`
1065 // ForceSendFields is a list of field names (e.g. "Destinations") to
1066 // unconditionally include in API requests. By default, fields with empty or
1067 // default values are omitted from API requests. See
1068 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1069 // details.
1070 ForceSendFields []string `json:"-"`
1071 // NullFields is a list of field names (e.g. "Destinations") to include in API
1072 // requests with the JSON null value. By default, fields with empty values are
1073 // omitted from API requests. See
1074 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1075 NullFields []string `json:"-"`
1076 }
1077
1078 func (s CommonLanguageSettings) MarshalJSON() ([]byte, error) {
1079 type NoMethod CommonLanguageSettings
1080 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1081 }
1082
1083 // Connection: Represents a private connection resource. A private connection
1084 // is implemented as a VPC Network Peering connection between a service
1085 // producer's VPC network and a service consumer's VPC network.
1086 type Connection struct {
1087 // Network: Required. The name of service consumer's VPC network that's
1088 // connected with service producer network, in the following format:
1089 // `projects/{project}/global/networks/{network}`. `{project}` is a project
1090 // number, such as in `12345` that includes the VPC service consumer's VPC
1091 // network. `{network}` is the name of the service consumer's VPC network.
1092 Network string `json:"network,omitempty"`
1093 // Peering: Output only. The name of the VPC Network Peering connection that
1094 // was created by the service producer.
1095 Peering string `json:"peering,omitempty"`
1096 // ReservedPeeringRanges: The name of one or more allocated IP address ranges
1097 // for this service producer of type `PEERING`. Note that invoking
1098 // CreateConnection method with a different range when connection is already
1099 // established will not modify already provisioned service producer
1100 // subnetworks. If CreateConnection method is invoked repeatedly to reconnect
1101 // when peering connection had been disconnected on the consumer side, leaving
1102 // this field empty will restore previously allocated IP ranges.
1103 ReservedPeeringRanges []string `json:"reservedPeeringRanges,omitempty"`
1104 // Service: Output only. The name of the peering service that's associated with
1105 // this connection, in the following format: `services/{service name}`.
1106 Service string `json:"service,omitempty"`
1107 // ForceSendFields is a list of field names (e.g. "Network") to unconditionally
1108 // include in API requests. By default, fields with empty or default values are
1109 // omitted from API requests. See
1110 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1111 // details.
1112 ForceSendFields []string `json:"-"`
1113 // NullFields is a list of field names (e.g. "Network") to include in API
1114 // requests with the JSON null value. By default, fields with empty values are
1115 // omitted from API requests. See
1116 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1117 NullFields []string `json:"-"`
1118 }
1119
1120 func (s Connection) MarshalJSON() ([]byte, error) {
1121 type NoMethod Connection
1122 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1123 }
1124
1125 // ConsumerConfig: Configuration information for a private service access
1126 // connection.
1127 type ConsumerConfig struct {
1128 // CloudsqlConfigs: Represents one or multiple Cloud SQL configurations.
1129 CloudsqlConfigs []*CloudSQLConfig `json:"cloudsqlConfigs,omitempty"`
1130 // ConsumerExportCustomRoutes: Export custom routes flag value for peering from
1131 // consumer to producer.
1132 ConsumerExportCustomRoutes bool `json:"consumerExportCustomRoutes,omitempty"`
1133 // ConsumerExportSubnetRoutesWithPublicIp: Export subnet routes with public ip
1134 // flag value for peering from consumer to producer.
1135 ConsumerExportSubnetRoutesWithPublicIp bool `json:"consumerExportSubnetRoutesWithPublicIp,omitempty"`
1136 // ConsumerImportCustomRoutes: Import custom routes flag value for peering from
1137 // consumer to producer.
1138 ConsumerImportCustomRoutes bool `json:"consumerImportCustomRoutes,omitempty"`
1139 // ConsumerImportSubnetRoutesWithPublicIp: Import subnet routes with public ip
1140 // flag value for peering from consumer to producer.
1141 ConsumerImportSubnetRoutesWithPublicIp bool `json:"consumerImportSubnetRoutesWithPublicIp,omitempty"`
1142 // ConsumerPeeringActive: Output only. If this is true, consumer peering is
1143 // active.
1144 ConsumerPeeringActive bool `json:"consumerPeeringActive,omitempty"`
1145 // ProducerExportCustomRoutes: Export custom routes flag value for peering from
1146 // producer to consumer.
1147 ProducerExportCustomRoutes bool `json:"producerExportCustomRoutes,omitempty"`
1148 // ProducerExportSubnetRoutesWithPublicIp: Export subnet routes with public ip
1149 // flag value for peering from producer to consumer.
1150 ProducerExportSubnetRoutesWithPublicIp bool `json:"producerExportSubnetRoutesWithPublicIp,omitempty"`
1151 // ProducerImportCustomRoutes: Import custom routes flag value for peering from
1152 // producer to consumer.
1153 ProducerImportCustomRoutes bool `json:"producerImportCustomRoutes,omitempty"`
1154 // ProducerImportSubnetRoutesWithPublicIp: Import subnet routes with public ip
1155 // flag value for peering from producer to consumer.
1156 ProducerImportSubnetRoutesWithPublicIp bool `json:"producerImportSubnetRoutesWithPublicIp,omitempty"`
1157 // ProducerNetwork: Output only. The VPC host network that is used to host
1158 // managed service instances. In the format,
1159 // projects/{project}/global/networks/{network} where {project} is the project
1160 // number e.g. '12345' and {network} is the network name.
1161 ProducerNetwork string `json:"producerNetwork,omitempty"`
1162 // ReservedRanges: Output only. The reserved ranges associated with this
1163 // private service access connection.
1164 ReservedRanges []*GoogleCloudServicenetworkingV1ConsumerConfigReservedRange `json:"reservedRanges,omitempty"`
1165 // UsedIpRanges: Output only. The IP ranges already in use by consumer or
1166 // producer
1167 UsedIpRanges []string `json:"usedIpRanges,omitempty"`
1168 // VpcScReferenceArchitectureEnabled: Output only. Indicates whether the VPC
1169 // Service Controls reference architecture is configured for the producer VPC
1170 // host network.
1171 VpcScReferenceArchitectureEnabled bool `json:"vpcScReferenceArchitectureEnabled,omitempty"`
1172 // ForceSendFields is a list of field names (e.g. "CloudsqlConfigs") to
1173 // unconditionally include in API requests. By default, fields with empty or
1174 // default values are omitted from API requests. See
1175 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1176 // details.
1177 ForceSendFields []string `json:"-"`
1178 // NullFields is a list of field names (e.g. "CloudsqlConfigs") to include in
1179 // API requests with the JSON null value. By default, fields with empty values
1180 // are omitted from API requests. See
1181 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1182 NullFields []string `json:"-"`
1183 }
1184
1185 func (s ConsumerConfig) MarshalJSON() ([]byte, error) {
1186 type NoMethod ConsumerConfig
1187 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1188 }
1189
1190 // ConsumerConfigMetadata: Metadata provided through GetOperation request for
1191 // the LRO generated by UpdateConsumerConfig API.
1192 type ConsumerConfigMetadata struct {
1193 }
1194
1195 // Context: `Context` defines which contexts an API requests. Example: context:
1196 // rules: - selector: "*" requested: - google.rpc.context.ProjectContext -
1197 // google.rpc.context.OriginContext The above specifies that all methods in the
1198 // API request `google.rpc.context.ProjectContext` and
1199 // `google.rpc.context.OriginContext`. Available context types are defined in
1200 // package `google.rpc.context`. This also provides mechanism to allowlist any
1201 // protobuf message extension that can be sent in grpc metadata using
1202 // “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list
1203 // any service specific protobuf types that can appear in grpc metadata as
1204 // follows in your yaml file: Example: context: rules: - selector:
1205 // "google.example.library.v1.LibraryService.CreateBook"
1206 // allowed_request_extensions: - google.foo.v1.NewExtension
1207 // allowed_response_extensions: - google.foo.v1.NewExtension You can also
1208 // specify extension ID instead of fully qualified extension name here.
1209 type Context struct {
1210 // Rules: A list of RPC context rules that apply to individual API methods.
1211 // **NOTE:** All service configuration rules follow "last one wins" order.
1212 Rules []*ContextRule `json:"rules,omitempty"`
1213 // ForceSendFields is a list of field names (e.g. "Rules") to unconditionally
1214 // include in API requests. By default, fields with empty or default values are
1215 // omitted from API requests. See
1216 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1217 // details.
1218 ForceSendFields []string `json:"-"`
1219 // NullFields is a list of field names (e.g. "Rules") to include in API
1220 // requests with the JSON null value. By default, fields with empty values are
1221 // omitted from API requests. See
1222 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1223 NullFields []string `json:"-"`
1224 }
1225
1226 func (s Context) MarshalJSON() ([]byte, error) {
1227 type NoMethod Context
1228 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1229 }
1230
1231 // ContextRule: A context rule provides information about the context for an
1232 // individual API element.
1233 type ContextRule struct {
1234 // AllowedRequestExtensions: A list of full type names or extension IDs of
1235 // extensions allowed in grpc side channel from client to backend.
1236 AllowedRequestExtensions []string `json:"allowedRequestExtensions,omitempty"`
1237 // AllowedResponseExtensions: A list of full type names or extension IDs of
1238 // extensions allowed in grpc side channel from backend to client.
1239 AllowedResponseExtensions []string `json:"allowedResponseExtensions,omitempty"`
1240 // Provided: A list of full type names of provided contexts. It is used to
1241 // support propagating HTTP headers and ETags from the response extension.
1242 Provided []string `json:"provided,omitempty"`
1243 // Requested: A list of full type names of requested contexts, only the
1244 // requested context will be made available to the backend.
1245 Requested []string `json:"requested,omitempty"`
1246 // Selector: Selects the methods to which this rule applies. Refer to selector
1247 // for syntax details.
1248 Selector string `json:"selector,omitempty"`
1249 // ForceSendFields is a list of field names (e.g. "AllowedRequestExtensions")
1250 // to unconditionally include in API requests. By default, fields with empty or
1251 // default values are omitted from API requests. See
1252 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1253 // details.
1254 ForceSendFields []string `json:"-"`
1255 // NullFields is a list of field names (e.g. "AllowedRequestExtensions") to
1256 // include in API requests with the JSON null value. By default, fields with
1257 // empty values are omitted from API requests. See
1258 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1259 NullFields []string `json:"-"`
1260 }
1261
1262 func (s ContextRule) MarshalJSON() ([]byte, error) {
1263 type NoMethod ContextRule
1264 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1265 }
1266
1267 // Control: Selects and configures the service controller used by the service.
1268 // Example: control: environment: servicecontrol.googleapis.com
1269 type Control struct {
1270 // Environment: The service controller environment to use. If empty, no control
1271 // plane features (like quota and billing) will be enabled. The recommended
1272 // value for most services is servicecontrol.googleapis.com.
1273 Environment string `json:"environment,omitempty"`
1274 // MethodPolicies: Defines policies applying to the API methods of the service.
1275 MethodPolicies []*MethodPolicy `json:"methodPolicies,omitempty"`
1276 // ForceSendFields is a list of field names (e.g. "Environment") to
1277 // unconditionally include in API requests. By default, fields with empty or
1278 // default values are omitted from API requests. See
1279 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1280 // details.
1281 ForceSendFields []string `json:"-"`
1282 // NullFields is a list of field names (e.g. "Environment") to include in API
1283 // requests with the JSON null value. By default, fields with empty values are
1284 // omitted from API requests. See
1285 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1286 NullFields []string `json:"-"`
1287 }
1288
1289 func (s Control) MarshalJSON() ([]byte, error) {
1290 type NoMethod Control
1291 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1292 }
1293
1294 // CppSettings: Settings for C++ client libraries.
1295 type CppSettings struct {
1296 // Common: Some settings.
1297 Common *CommonLanguageSettings `json:"common,omitempty"`
1298 // ForceSendFields is a list of field names (e.g. "Common") to unconditionally
1299 // include in API requests. By default, fields with empty or default values are
1300 // omitted from API requests. See
1301 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1302 // details.
1303 ForceSendFields []string `json:"-"`
1304 // NullFields is a list of field names (e.g. "Common") to include in API
1305 // requests with the JSON null value. By default, fields with empty values are
1306 // omitted from API requests. See
1307 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1308 NullFields []string `json:"-"`
1309 }
1310
1311 func (s CppSettings) MarshalJSON() ([]byte, error) {
1312 type NoMethod CppSettings
1313 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1314 }
1315
1316 // CustomError: Customize service error responses. For example, list any
1317 // service specific protobuf types that can appear in error detail lists of
1318 // error responses. Example: custom_error: types: - google.foo.v1.CustomError -
1319 // google.foo.v1.AnotherError
1320 type CustomError struct {
1321 // Rules: The list of custom error rules that apply to individual API messages.
1322 // **NOTE:** All service configuration rules follow "last one wins" order.
1323 Rules []*CustomErrorRule `json:"rules,omitempty"`
1324 // Types: The list of custom error detail types, e.g.
1325 // 'google.foo.v1.CustomError'.
1326 Types []string `json:"types,omitempty"`
1327 // ForceSendFields is a list of field names (e.g. "Rules") to unconditionally
1328 // include in API requests. By default, fields with empty or default values are
1329 // omitted from API requests. See
1330 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1331 // details.
1332 ForceSendFields []string `json:"-"`
1333 // NullFields is a list of field names (e.g. "Rules") to include in API
1334 // requests with the JSON null value. By default, fields with empty values are
1335 // omitted from API requests. See
1336 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1337 NullFields []string `json:"-"`
1338 }
1339
1340 func (s CustomError) MarshalJSON() ([]byte, error) {
1341 type NoMethod CustomError
1342 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1343 }
1344
1345 // CustomErrorRule: A custom error rule.
1346 type CustomErrorRule struct {
1347 // IsErrorType: Mark this message as possible payload in error response.
1348 // Otherwise, objects of this type will be filtered when they appear in error
1349 // payload.
1350 IsErrorType bool `json:"isErrorType,omitempty"`
1351 // Selector: Selects messages to which this rule applies. Refer to selector for
1352 // syntax details.
1353 Selector string `json:"selector,omitempty"`
1354 // ForceSendFields is a list of field names (e.g. "IsErrorType") to
1355 // unconditionally include in API requests. By default, fields with empty or
1356 // default values are omitted from API requests. See
1357 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1358 // details.
1359 ForceSendFields []string `json:"-"`
1360 // NullFields is a list of field names (e.g. "IsErrorType") to include in API
1361 // requests with the JSON null value. By default, fields with empty values are
1362 // omitted from API requests. See
1363 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1364 NullFields []string `json:"-"`
1365 }
1366
1367 func (s CustomErrorRule) MarshalJSON() ([]byte, error) {
1368 type NoMethod CustomErrorRule
1369 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1370 }
1371
1372 // CustomHttpPattern: A custom pattern is used for defining custom HTTP verb.
1373 type CustomHttpPattern struct {
1374 // Kind: The name of this custom HTTP verb.
1375 Kind string `json:"kind,omitempty"`
1376 // Path: The path matched by this custom verb.
1377 Path string `json:"path,omitempty"`
1378 // ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
1379 // include in API requests. By default, fields with empty or default values are
1380 // omitted from API requests. See
1381 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1382 // details.
1383 ForceSendFields []string `json:"-"`
1384 // NullFields is a list of field names (e.g. "Kind") to include in API requests
1385 // with the JSON null value. By default, fields with empty values are omitted
1386 // from API requests. See
1387 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1388 NullFields []string `json:"-"`
1389 }
1390
1391 func (s CustomHttpPattern) MarshalJSON() ([]byte, error) {
1392 type NoMethod CustomHttpPattern
1393 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1394 }
1395
1396 // DeleteConnectionMetadata: Metadata provided through GetOperation request for
1397 // the LRO generated by Delete Connection API
1398 type DeleteConnectionMetadata struct {
1399 }
1400
1401 // DeletePeeredDnsDomainMetadata: Metadata provided through GetOperation
1402 // request for the LRO generated by DeletePeeredDnsDomain API.
1403 type DeletePeeredDnsDomainMetadata struct {
1404 }
1405
1406 // DnsRecordSet: Represents a DNS record set resource.
1407 type DnsRecordSet struct {
1408 // Data: Required. As defined in RFC 1035 (section 5) and RFC 1034 (section
1409 // 3.6.1) for examples see https://cloud.google.com/dns/records/json-record.
1410 Data []string `json:"data,omitempty"`
1411 // Domain: Required. The DNS or domain name of the record set, e.g.
1412 // `test.example.com`. Cloud DNS requires that a DNS suffix ends with a
1413 // trailing dot.
1414 Domain string `json:"domain,omitempty"`
1415 // Ttl: Required. The period of time for which this RecordSet can be cached by
1416 // resolvers.
1417 Ttl string `json:"ttl,omitempty"`
1418 // Type: Required. The identifier of a supported record type.
1419 Type string `json:"type,omitempty"`
1420 // ForceSendFields is a list of field names (e.g. "Data") to unconditionally
1421 // include in API requests. By default, fields with empty or default values are
1422 // omitted from API requests. See
1423 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1424 // details.
1425 ForceSendFields []string `json:"-"`
1426 // NullFields is a list of field names (e.g. "Data") to include in API requests
1427 // with the JSON null value. By default, fields with empty values are omitted
1428 // from API requests. See
1429 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1430 NullFields []string `json:"-"`
1431 }
1432
1433 func (s DnsRecordSet) MarshalJSON() ([]byte, error) {
1434 type NoMethod DnsRecordSet
1435 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1436 }
1437
1438 // DnsZone: Represents a DNS zone resource.
1439 type DnsZone struct {
1440 // DnsSuffix: The DNS name suffix of this zone e.g. `example.com.`. Cloud DNS
1441 // requires that a DNS suffix ends with a trailing dot.
1442 DnsSuffix string `json:"dnsSuffix,omitempty"`
1443 // Name: User assigned name for this resource. Must be unique within the
1444 // project. The name must be 1-63 characters long, must begin with a letter,
1445 // end with a letter or digit, and only contain lowercase letters, digits or
1446 // dashes.
1447 Name string `json:"name,omitempty"`
1448 // ForceSendFields is a list of field names (e.g. "DnsSuffix") to
1449 // unconditionally include in API requests. By default, fields with empty or
1450 // default values are omitted from API requests. See
1451 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1452 // details.
1453 ForceSendFields []string `json:"-"`
1454 // NullFields is a list of field names (e.g. "DnsSuffix") to include in API
1455 // requests with the JSON null value. By default, fields with empty values are
1456 // omitted from API requests. See
1457 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1458 NullFields []string `json:"-"`
1459 }
1460
1461 func (s DnsZone) MarshalJSON() ([]byte, error) {
1462 type NoMethod DnsZone
1463 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1464 }
1465
1466 // Documentation: `Documentation` provides the information for describing a
1467 // service. Example: documentation: summary: > The Google Calendar API gives
1468 // access to most calendar features. pages: - name: Overview content: (==
1469 // include google/foo/overview.md ==) - name: Tutorial content: (== include
1470 // google/foo/tutorial.md ==) subpages: - name: Java content: (== include
1471 // google/foo/tutorial_java.md ==) rules: - selector:
1472 // google.calendar.Calendar.Get description: > ... - selector:
1473 // google.calendar.Calendar.Put description: > ... Documentation is provided in
1474 // markdown syntax. In addition to standard markdown features, definition
1475 // lists, tables and fenced code blocks are supported. Section headers can be
1476 // provided and are interpreted relative to the section nesting of the context
1477 // where a documentation fragment is embedded. Documentation from the IDL is
1478 // merged with documentation defined via the config at normalization time,
1479 // where documentation provided by config rules overrides IDL provided. A
1480 // number of constructs specific to the API platform are supported in
1481 // documentation text. In order to reference a proto element, the following
1482 // notation can be used: [fully.qualified.proto.name][] To override the display
1483 // text used for the link, this can be used: [display
1484 // text][fully.qualified.proto.name] Text can be excluded from doc using the
1485 // following notation: (-- internal comment --) A few directives are available
1486 // in documentation. Note that directives must appear on a single line to be
1487 // properly identified. The `include` directive includes a markdown file from
1488 // an external source: (== include path/to/file ==) The `resource_for`
1489 // directive marks a message to be the resource of a collection in REST view.
1490 // If it is not specified, tools attempt to infer the resource from the
1491 // operations in a collection: (== resource_for v1.shelves.books ==) The
1492 // directive `suppress_warning` does not directly affect documentation and is
1493 // documented together with service config validation.
1494 type Documentation struct {
1495 // AdditionalIamInfo: Optional information about the IAM configuration. This is
1496 // typically used to link to documentation about a product's IAM roles and
1497 // permissions.
1498 AdditionalIamInfo string `json:"additionalIamInfo,omitempty"`
1499 // DocumentationRootUrl: The URL to the root of documentation.
1500 DocumentationRootUrl string `json:"documentationRootUrl,omitempty"`
1501 // Overview: Declares a single overview page. For example: documentation:
1502 // summary: ... overview: (== include overview.md ==) This is a shortcut for
1503 // the following declaration (using pages style): documentation: summary: ...
1504 // pages: - name: Overview content: (== include overview.md ==) Note: you
1505 // cannot specify both `overview` field and `pages` field.
1506 Overview string `json:"overview,omitempty"`
1507 // Pages: The top level pages for the documentation set.
1508 Pages []*Page `json:"pages,omitempty"`
1509 // Rules: A list of documentation rules that apply to individual API elements.
1510 // **NOTE:** All service configuration rules follow "last one wins" order.
1511 Rules []*DocumentationRule `json:"rules,omitempty"`
1512 // SectionOverrides: Specifies section and content to override the boilerplate
1513 // content. Currently overrides following sections: 1.
1514 // rest.service.client_libraries
1515 SectionOverrides []*Page `json:"sectionOverrides,omitempty"`
1516 // ServiceRootUrl: Specifies the service root url if the default one (the
1517 // service name from the yaml file) is not suitable. This can be seen in any
1518 // fully specified service urls as well as sections that show a base that other
1519 // urls are relative to.
1520 ServiceRootUrl string `json:"serviceRootUrl,omitempty"`
1521 // Summary: A short description of what the service does. The summary must be
1522 // plain text. It becomes the overview of the service displayed in Google Cloud
1523 // Console. NOTE: This field is equivalent to the standard field `description`.
1524 Summary string `json:"summary,omitempty"`
1525 // ForceSendFields is a list of field names (e.g. "AdditionalIamInfo") to
1526 // unconditionally include in API requests. By default, fields with empty or
1527 // default values are omitted from API requests. See
1528 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1529 // details.
1530 ForceSendFields []string `json:"-"`
1531 // NullFields is a list of field names (e.g. "AdditionalIamInfo") to include in
1532 // API requests with the JSON null value. By default, fields with empty values
1533 // are omitted from API requests. See
1534 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1535 NullFields []string `json:"-"`
1536 }
1537
1538 func (s Documentation) MarshalJSON() ([]byte, error) {
1539 type NoMethod Documentation
1540 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1541 }
1542
1543 // DocumentationRule: A documentation rule provides information about
1544 // individual API elements.
1545 type DocumentationRule struct {
1546 // DeprecationDescription: Deprecation description of the selected element(s).
1547 // It can be provided if an element is marked as `deprecated`.
1548 DeprecationDescription string `json:"deprecationDescription,omitempty"`
1549 // Description: Description of the selected proto element (e.g. a message, a
1550 // method, a 'service' definition, or a field). Defaults to leading & trailing
1551 // comments taken from the proto source definition of the proto element.
1552 Description string `json:"description,omitempty"`
1553 // DisableReplacementWords: String of comma or space separated case-sensitive
1554 // words for which method/field name replacement will be disabled.
1555 DisableReplacementWords string `json:"disableReplacementWords,omitempty"`
1556 // Selector: The selector is a comma-separated list of patterns for any element
1557 // such as a method, a field, an enum value. Each pattern is a qualified name
1558 // of the element which may end in "*", indicating a wildcard. Wildcards are
1559 // only allowed at the end and for a whole component of the qualified name,
1560 // i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match
1561 // one or more components. To specify a default for all applicable elements,
1562 // the whole pattern "*" is used.
1563 Selector string `json:"selector,omitempty"`
1564 // ForceSendFields is a list of field names (e.g. "DeprecationDescription") to
1565 // unconditionally include in API requests. By default, fields with empty or
1566 // default values are omitted from API requests. See
1567 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1568 // details.
1569 ForceSendFields []string `json:"-"`
1570 // NullFields is a list of field names (e.g. "DeprecationDescription") to
1571 // include in API requests with the JSON null value. By default, fields with
1572 // empty values are omitted from API requests. See
1573 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1574 NullFields []string `json:"-"`
1575 }
1576
1577 func (s DocumentationRule) MarshalJSON() ([]byte, error) {
1578 type NoMethod DocumentationRule
1579 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1580 }
1581
1582 // DotnetSettings: Settings for Dotnet client libraries.
1583 type DotnetSettings struct {
1584 // Common: Some settings.
1585 Common *CommonLanguageSettings `json:"common,omitempty"`
1586 // ForcedNamespaceAliases: Namespaces which must be aliased in snippets due to
1587 // a known (but non-generator-predictable) naming collision
1588 ForcedNamespaceAliases []string `json:"forcedNamespaceAliases,omitempty"`
1589 // HandwrittenSignatures: Method signatures (in the form
1590 // "service.method(signature)") which are provided separately, so shouldn't be
1591 // generated. Snippets *calling* these methods are still generated, however.
1592 HandwrittenSignatures []string `json:"handwrittenSignatures,omitempty"`
1593 // IgnoredResources: List of full resource types to ignore during generation.
1594 // This is typically used for API-specific Location resources, which should be
1595 // handled by the generator as if they were actually the common Location
1596 // resources. Example entry: "documentai.googleapis.com/Location"
1597 IgnoredResources []string `json:"ignoredResources,omitempty"`
1598 // RenamedResources: Map from full resource types to the effective short name
1599 // for the resource. This is used when otherwise resource named from different
1600 // services would cause naming collisions. Example entry:
1601 // "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
1602 RenamedResources map[string]string `json:"renamedResources,omitempty"`
1603 // RenamedServices: Map from original service names to renamed versions. This
1604 // is used when the default generated types would cause a naming conflict.
1605 // (Neither name is fully-qualified.) Example: Subscriber to
1606 // SubscriberServiceApi.
1607 RenamedServices map[string]string `json:"renamedServices,omitempty"`
1608 // ForceSendFields is a list of field names (e.g. "Common") to unconditionally
1609 // include in API requests. By default, fields with empty or default values are
1610 // omitted from API requests. See
1611 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1612 // details.
1613 ForceSendFields []string `json:"-"`
1614 // NullFields is a list of field names (e.g. "Common") to include in API
1615 // requests with the JSON null value. By default, fields with empty values are
1616 // omitted from API requests. See
1617 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1618 NullFields []string `json:"-"`
1619 }
1620
1621 func (s DotnetSettings) MarshalJSON() ([]byte, error) {
1622 type NoMethod DotnetSettings
1623 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1624 }
1625
1626 // Endpoint: `Endpoint` describes a network address of a service that serves a
1627 // set of APIs. It is commonly known as a service endpoint. A service may
1628 // expose any number of service endpoints, and all service endpoints share the
1629 // same service definition, such as quota limits and monitoring metrics.
1630 // Example: type: google.api.Service name: library-example.googleapis.com
1631 // endpoints: # Declares network address
1632 // `https://library-example.googleapis.com` # for service
1633 // `library-example.googleapis.com`. The `https` scheme # is implicit for all
1634 // service endpoints. Other schemes may be # supported in the future. - name:
1635 // library-example.googleapis.com allow_cors: false - name:
1636 // content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls
1637 // to be passed to the API frontend, for it # to decide whether the subsequent
1638 // cross-origin request is allowed # to proceed. allow_cors: true
1639 type Endpoint struct {
1640 // Aliases: Aliases for this endpoint, these will be served by the same UrlMap
1641 // as the parent endpoint, and will be provisioned in the GCP stack for the
1642 // Regional Endpoints.
1643 Aliases []string `json:"aliases,omitempty"`
1644 // AllowCors: Allowing CORS
1645 // (https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
1646 // cross-domain traffic, would allow the backends served from this endpoint to
1647 // receive and respond to HTTP OPTIONS requests. The response will be used by
1648 // the browser to determine whether the subsequent cross-origin request is
1649 // allowed to proceed.
1650 AllowCors bool `json:"allowCors,omitempty"`
1651 // Name: The canonical name of this endpoint.
1652 Name string `json:"name,omitempty"`
1653 // Target: The specification of an Internet routable address of API frontend
1654 // that will handle requests to this API Endpoint
1655 // (https://cloud.google.com/apis/design/glossary). It should be either a valid
1656 // IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or
1657 // "myservice.appspot.com".
1658 Target string `json:"target,omitempty"`
1659 // ForceSendFields is a list of field names (e.g. "Aliases") to unconditionally
1660 // include in API requests. By default, fields with empty or default values are
1661 // omitted from API requests. See
1662 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1663 // details.
1664 ForceSendFields []string `json:"-"`
1665 // NullFields is a list of field names (e.g. "Aliases") to include in API
1666 // requests with the JSON null value. By default, fields with empty values are
1667 // omitted from API requests. See
1668 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1669 NullFields []string `json:"-"`
1670 }
1671
1672 func (s Endpoint) MarshalJSON() ([]byte, error) {
1673 type NoMethod Endpoint
1674 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1675 }
1676
1677 // Enum: Enum type definition. New usages of this message as an alternative to
1678 // EnumDescriptorProto are strongly discouraged. This message does not
1679 // reliability preserve all information necessary to model the schema and
1680 // preserve semantics. Instead make use of FileDescriptorSet which preserves
1681 // the necessary information.
1682 type Enum struct {
1683 // Edition: The source edition string, only valid when syntax is
1684 // SYNTAX_EDITIONS.
1685 Edition string `json:"edition,omitempty"`
1686 // Enumvalue: Enum value definitions.
1687 Enumvalue []*EnumValue `json:"enumvalue,omitempty"`
1688 // Name: Enum type name.
1689 Name string `json:"name,omitempty"`
1690 // Options: Protocol buffer options.
1691 Options []*Option `json:"options,omitempty"`
1692 // SourceContext: The source context.
1693 SourceContext *SourceContext `json:"sourceContext,omitempty"`
1694 // Syntax: The source syntax.
1695 //
1696 // Possible values:
1697 // "SYNTAX_PROTO2" - Syntax `proto2`.
1698 // "SYNTAX_PROTO3" - Syntax `proto3`.
1699 // "SYNTAX_EDITIONS" - Syntax `editions`.
1700 Syntax string `json:"syntax,omitempty"`
1701 // ForceSendFields is a list of field names (e.g. "Edition") to unconditionally
1702 // include in API requests. By default, fields with empty or default values are
1703 // omitted from API requests. See
1704 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1705 // details.
1706 ForceSendFields []string `json:"-"`
1707 // NullFields is a list of field names (e.g. "Edition") to include in API
1708 // requests with the JSON null value. By default, fields with empty values are
1709 // omitted from API requests. See
1710 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1711 NullFields []string `json:"-"`
1712 }
1713
1714 func (s Enum) MarshalJSON() ([]byte, error) {
1715 type NoMethod Enum
1716 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1717 }
1718
1719 // EnumValue: Enum value definition. New usages of this message as an
1720 // alternative to EnumValueDescriptorProto are strongly discouraged. This
1721 // message does not reliability preserve all information necessary to model the
1722 // schema and preserve semantics. Instead make use of FileDescriptorSet which
1723 // preserves the necessary information.
1724 type EnumValue struct {
1725 // Name: Enum value name.
1726 Name string `json:"name,omitempty"`
1727 // Number: Enum value number.
1728 Number int64 `json:"number,omitempty"`
1729 // Options: Protocol buffer options.
1730 Options []*Option `json:"options,omitempty"`
1731 // ForceSendFields is a list of field names (e.g. "Name") to unconditionally
1732 // include in API requests. By default, fields with empty or default values are
1733 // omitted from API requests. See
1734 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1735 // details.
1736 ForceSendFields []string `json:"-"`
1737 // NullFields is a list of field names (e.g. "Name") to include in API requests
1738 // with the JSON null value. By default, fields with empty values are omitted
1739 // from API requests. See
1740 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1741 NullFields []string `json:"-"`
1742 }
1743
1744 func (s EnumValue) MarshalJSON() ([]byte, error) {
1745 type NoMethod EnumValue
1746 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1747 }
1748
1749 // ExperimentalFeatures: Experimental features to be included during client
1750 // library generation. These fields will be deprecated once the feature
1751 // graduates and is enabled by default.
1752 type ExperimentalFeatures struct {
1753 // ProtobufPythonicTypesEnabled: Enables generation of protobuf code using new
1754 // types that are more Pythonic which are included in `protobuf>=5.29.x`. This
1755 // feature will be enabled by default 1 month after launching the feature in
1756 // preview packages.
1757 ProtobufPythonicTypesEnabled bool `json:"protobufPythonicTypesEnabled,omitempty"`
1758 // RestAsyncIoEnabled: Enables generation of asynchronous REST clients if
1759 // `rest` transport is enabled. By default, asynchronous REST clients will not
1760 // be generated. This feature will be enabled by default 1 month after
1761 // launching the feature in preview packages.
1762 RestAsyncIoEnabled bool `json:"restAsyncIoEnabled,omitempty"`
1763 // UnversionedPackageDisabled: Disables generation of an unversioned Python
1764 // package for this client library. This means that the module names will need
1765 // to be versioned in import statements. For example `import
1766 // google.cloud.library_v2` instead of `import google.cloud.library`.
1767 UnversionedPackageDisabled bool `json:"unversionedPackageDisabled,omitempty"`
1768 // ForceSendFields is a list of field names (e.g.
1769 // "ProtobufPythonicTypesEnabled") to unconditionally include in API requests.
1770 // By default, fields with empty or default values are omitted from API
1771 // requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
1772 // for more details.
1773 ForceSendFields []string `json:"-"`
1774 // NullFields is a list of field names (e.g. "ProtobufPythonicTypesEnabled") to
1775 // include in API requests with the JSON null value. By default, fields with
1776 // empty values are omitted from API requests. See
1777 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1778 NullFields []string `json:"-"`
1779 }
1780
1781 func (s ExperimentalFeatures) MarshalJSON() ([]byte, error) {
1782 type NoMethod ExperimentalFeatures
1783 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1784 }
1785
1786 // Field: A single field of a message type. New usages of this message as an
1787 // alternative to FieldDescriptorProto are strongly discouraged. This message
1788 // does not reliability preserve all information necessary to model the schema
1789 // and preserve semantics. Instead make use of FileDescriptorSet which
1790 // preserves the necessary information.
1791 type Field struct {
1792 // Cardinality: The field cardinality.
1793 //
1794 // Possible values:
1795 // "CARDINALITY_UNKNOWN" - For fields with unknown cardinality.
1796 // "CARDINALITY_OPTIONAL" - For optional fields.
1797 // "CARDINALITY_REQUIRED" - For required fields. Proto2 syntax only.
1798 // "CARDINALITY_REPEATED" - For repeated fields.
1799 Cardinality string `json:"cardinality,omitempty"`
1800 // DefaultValue: The string value of the default value of this field. Proto2
1801 // syntax only.
1802 DefaultValue string `json:"defaultValue,omitempty"`
1803 // JsonName: The field JSON name.
1804 JsonName string `json:"jsonName,omitempty"`
1805 // Kind: The field type.
1806 //
1807 // Possible values:
1808 // "TYPE_UNKNOWN" - Field type unknown.
1809 // "TYPE_DOUBLE" - Field type double.
1810 // "TYPE_FLOAT" - Field type float.
1811 // "TYPE_INT64" - Field type int64.
1812 // "TYPE_UINT64" - Field type uint64.
1813 // "TYPE_INT32" - Field type int32.
1814 // "TYPE_FIXED64" - Field type fixed64.
1815 // "TYPE_FIXED32" - Field type fixed32.
1816 // "TYPE_BOOL" - Field type bool.
1817 // "TYPE_STRING" - Field type string.
1818 // "TYPE_GROUP" - Field type group. Proto2 syntax only, and deprecated.
1819 // "TYPE_MESSAGE" - Field type message.
1820 // "TYPE_BYTES" - Field type bytes.
1821 // "TYPE_UINT32" - Field type uint32.
1822 // "TYPE_ENUM" - Field type enum.
1823 // "TYPE_SFIXED32" - Field type sfixed32.
1824 // "TYPE_SFIXED64" - Field type sfixed64.
1825 // "TYPE_SINT32" - Field type sint32.
1826 // "TYPE_SINT64" - Field type sint64.
1827 Kind string `json:"kind,omitempty"`
1828 // Name: The field name.
1829 Name string `json:"name,omitempty"`
1830 // Number: The field number.
1831 Number int64 `json:"number,omitempty"`
1832 // OneofIndex: The index of the field type in `Type.oneofs`, for message or
1833 // enumeration types. The first type has index 1; zero means the type is not in
1834 // the list.
1835 OneofIndex int64 `json:"oneofIndex,omitempty"`
1836 // Options: The protocol buffer options.
1837 Options []*Option `json:"options,omitempty"`
1838 // Packed: Whether to use alternative packed wire representation.
1839 Packed bool `json:"packed,omitempty"`
1840 // TypeUrl: The field type URL, without the scheme, for message or enumeration
1841 // types. Example: "type.googleapis.com/google.protobuf.Timestamp".
1842 TypeUrl string `json:"typeUrl,omitempty"`
1843 // ForceSendFields is a list of field names (e.g. "Cardinality") to
1844 // unconditionally include in API requests. By default, fields with empty or
1845 // default values are omitted from API requests. See
1846 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1847 // details.
1848 ForceSendFields []string `json:"-"`
1849 // NullFields is a list of field names (e.g. "Cardinality") to include in API
1850 // requests with the JSON null value. By default, fields with empty values are
1851 // omitted from API requests. See
1852 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1853 NullFields []string `json:"-"`
1854 }
1855
1856 func (s Field) MarshalJSON() ([]byte, error) {
1857 type NoMethod Field
1858 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1859 }
1860
1861 // FieldPolicy: Google API Policy Annotation This message defines a simple API
1862 // policy annotation that can be used to annotate API request and response
1863 // message fields with applicable policies. One field may have multiple
1864 // applicable policies that must all be satisfied before a request can be
1865 // processed. This policy annotation is used to generate the overall policy
1866 // that will be used for automatic runtime policy enforcement and documentation
1867 // generation.
1868 type FieldPolicy struct {
1869 // ResourcePermission: Specifies the required permission(s) for the resource
1870 // referred to by the field. It requires the field contains a valid resource
1871 // reference, and the request must pass the permission checks to proceed. For
1872 // example, "resourcemanager.projects.get".
1873 ResourcePermission string `json:"resourcePermission,omitempty"`
1874 // ResourceType: Specifies the resource type for the resource referred to by
1875 // the field.
1876 ResourceType string `json:"resourceType,omitempty"`
1877 // Selector: Selects one or more request or response message fields to apply
1878 // this `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the
1879 // selector must be left as empty. The service config generator will
1880 // automatically fill the correct value. When a `FieldPolicy` is used in
1881 // service config, the selector must be a comma-separated string with valid
1882 // request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
1883 Selector string `json:"selector,omitempty"`
1884 // ForceSendFields is a list of field names (e.g. "ResourcePermission") to
1885 // unconditionally include in API requests. By default, fields with empty or
1886 // default values are omitted from API requests. See
1887 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1888 // details.
1889 ForceSendFields []string `json:"-"`
1890 // NullFields is a list of field names (e.g. "ResourcePermission") to include
1891 // in API requests with the JSON null value. By default, fields with empty
1892 // values are omitted from API requests. See
1893 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1894 NullFields []string `json:"-"`
1895 }
1896
1897 func (s FieldPolicy) MarshalJSON() ([]byte, error) {
1898 type NoMethod FieldPolicy
1899 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1900 }
1901
1902 // GoSettings: Settings for Go client libraries.
1903 type GoSettings struct {
1904 // Common: Some settings.
1905 Common *CommonLanguageSettings `json:"common,omitempty"`
1906 // RenamedServices: Map of service names to renamed services. Keys are the
1907 // package relative service names and values are the name to be used for the
1908 // service client and call options. Example: publishing: go_settings:
1909 // renamed_services: Publisher: TopicAdmin
1910 RenamedServices map[string]string `json:"renamedServices,omitempty"`
1911 // ForceSendFields is a list of field names (e.g. "Common") to unconditionally
1912 // include in API requests. By default, fields with empty or default values are
1913 // omitted from API requests. See
1914 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1915 // details.
1916 ForceSendFields []string `json:"-"`
1917 // NullFields is a list of field names (e.g. "Common") to include in API
1918 // requests with the JSON null value. By default, fields with empty values are
1919 // omitted from API requests. See
1920 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1921 NullFields []string `json:"-"`
1922 }
1923
1924 func (s GoSettings) MarshalJSON() ([]byte, error) {
1925 type NoMethod GoSettings
1926 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1927 }
1928
1929 // GoogleCloudServicenetworkingV1ConsumerConfigReservedRange: Allocated IP
1930 // address ranges for this private service access connection.
1931 type GoogleCloudServicenetworkingV1ConsumerConfigReservedRange struct {
1932 // Address: The starting address of the reserved range. The address must be a
1933 // valid IPv4 address in the x.x.x.x format. This value combined with the IP
1934 // prefix length is the CIDR range for the reserved range.
1935 Address string `json:"address,omitempty"`
1936 // IpPrefixLength: The prefix length of the reserved range.
1937 IpPrefixLength int64 `json:"ipPrefixLength,omitempty"`
1938 // Name: The name of the reserved range.
1939 Name string `json:"name,omitempty"`
1940 // ForceSendFields is a list of field names (e.g. "Address") to unconditionally
1941 // include in API requests. By default, fields with empty or default values are
1942 // omitted from API requests. See
1943 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1944 // details.
1945 ForceSendFields []string `json:"-"`
1946 // NullFields is a list of field names (e.g. "Address") to include in API
1947 // requests with the JSON null value. By default, fields with empty values are
1948 // omitted from API requests. See
1949 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1950 NullFields []string `json:"-"`
1951 }
1952
1953 func (s GoogleCloudServicenetworkingV1ConsumerConfigReservedRange) MarshalJSON() ([]byte, error) {
1954 type NoMethod GoogleCloudServicenetworkingV1ConsumerConfigReservedRange
1955 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1956 }
1957
1958 // GoogleCloudServicenetworkingV1betaConnection: Represents a private
1959 // connection resource. A private connection is implemented as a VPC Network
1960 // Peering connection between a service producer's VPC network and a service
1961 // consumer's VPC network.
1962 type GoogleCloudServicenetworkingV1betaConnection struct {
1963 // Network: The name of service consumer's VPC network that's connected with
1964 // service producer network, in the following format:
1965 // `projects/{project}/global/networks/{network}`. `{project}` is a project
1966 // number, such as in `12345` that includes the VPC service consumer's VPC
1967 // network. `{network}` is the name of the service consumer's VPC network.
1968 Network string `json:"network,omitempty"`
1969 // Peering: Output only. The name of the VPC Network Peering connection that
1970 // was created by the service producer.
1971 Peering string `json:"peering,omitempty"`
1972 // ReservedPeeringRanges: The name of one or more allocated IP address ranges
1973 // for this service producer of type `PEERING`. Note that invoking this method
1974 // with a different range when connection is already established will not
1975 // modify already provisioned service producer subnetworks.
1976 ReservedPeeringRanges []string `json:"reservedPeeringRanges,omitempty"`
1977 // Service: Output only. The name of the peering service that's associated with
1978 // this connection, in the following format: `services/{service name}`.
1979 Service string `json:"service,omitempty"`
1980 // ForceSendFields is a list of field names (e.g. "Network") to unconditionally
1981 // include in API requests. By default, fields with empty or default values are
1982 // omitted from API requests. See
1983 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
1984 // details.
1985 ForceSendFields []string `json:"-"`
1986 // NullFields is a list of field names (e.g. "Network") to include in API
1987 // requests with the JSON null value. By default, fields with empty values are
1988 // omitted from API requests. See
1989 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
1990 NullFields []string `json:"-"`
1991 }
1992
1993 func (s GoogleCloudServicenetworkingV1betaConnection) MarshalJSON() ([]byte, error) {
1994 type NoMethod GoogleCloudServicenetworkingV1betaConnection
1995 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
1996 }
1997
1998 // GoogleCloudServicenetworkingV1betaSubnetwork: Represents a subnet that was
1999 // created or discovered by a private access management service.
2000 type GoogleCloudServicenetworkingV1betaSubnetwork struct {
2001 // IpCidrRange: Subnetwork CIDR range in `10.x.x.x/y` format.
2002 IpCidrRange string `json:"ipCidrRange,omitempty"`
2003 // Name: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/
2004 Name string `json:"name,omitempty"`
2005 // Network: In the Shared VPC host project, the VPC network that's peered with
2006 // the consumer network. For example:
2007 // `projects/1234321/global/networks/host-network`
2008 Network string `json:"network,omitempty"`
2009 // OutsideAllocation: This is a discovered subnet that is not within the
2010 // current consumer allocated ranges.
2011 OutsideAllocation bool `json:"outsideAllocation,omitempty"`
2012 // ForceSendFields is a list of field names (e.g. "IpCidrRange") to
2013 // unconditionally include in API requests. By default, fields with empty or
2014 // default values are omitted from API requests. See
2015 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2016 // details.
2017 ForceSendFields []string `json:"-"`
2018 // NullFields is a list of field names (e.g. "IpCidrRange") to include in API
2019 // requests with the JSON null value. By default, fields with empty values are
2020 // omitted from API requests. See
2021 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2022 NullFields []string `json:"-"`
2023 }
2024
2025 func (s GoogleCloudServicenetworkingV1betaSubnetwork) MarshalJSON() ([]byte, error) {
2026 type NoMethod GoogleCloudServicenetworkingV1betaSubnetwork
2027 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2028 }
2029
2030 // Http: Defines the HTTP configuration for an API service. It contains a list
2031 // of HttpRule, each specifying the mapping of an RPC method to one or more
2032 // HTTP REST API methods.
2033 type Http struct {
2034 // FullyDecodeReservedExpansion: When set to true, URL path parameters will be
2035 // fully URI-decoded except in cases of single segment matches in reserved
2036 // expansion, where "%2F" will be left encoded. The default behavior is to not
2037 // decode RFC 6570 reserved characters in multi segment matches.
2038 FullyDecodeReservedExpansion bool `json:"fullyDecodeReservedExpansion,omitempty"`
2039 // Rules: A list of HTTP configuration rules that apply to individual API
2040 // methods. **NOTE:** All service configuration rules follow "last one wins"
2041 // order.
2042 Rules []*HttpRule `json:"rules,omitempty"`
2043 // ForceSendFields is a list of field names (e.g.
2044 // "FullyDecodeReservedExpansion") to unconditionally include in API requests.
2045 // By default, fields with empty or default values are omitted from API
2046 // requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
2047 // for more details.
2048 ForceSendFields []string `json:"-"`
2049 // NullFields is a list of field names (e.g. "FullyDecodeReservedExpansion") to
2050 // include in API requests with the JSON null value. By default, fields with
2051 // empty values are omitted from API requests. See
2052 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2053 NullFields []string `json:"-"`
2054 }
2055
2056 func (s Http) MarshalJSON() ([]byte, error) {
2057 type NoMethod Http
2058 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2059 }
2060
2061 // HttpRule: gRPC Transcoding gRPC Transcoding is a feature for mapping between
2062 // a gRPC method and one or more HTTP REST endpoints. It allows developers to
2063 // build a single API service that supports both gRPC APIs and REST APIs. Many
2064 // systems, including Google APIs (https://github.com/googleapis/googleapis),
2065 // Cloud Endpoints (https://cloud.google.com/endpoints), gRPC Gateway
2066 // (https://github.com/grpc-ecosystem/grpc-gateway), and Envoy
2067 // (https://github.com/envoyproxy/envoy) proxy support this feature and use it
2068 // for large scale production services. `HttpRule` defines the schema of the
2069 // gRPC/REST mapping. The mapping specifies how different portions of the gRPC
2070 // request message are mapped to the URL path, URL query parameters, and HTTP
2071 // request body. It also controls how the gRPC response message is mapped to
2072 // the HTTP response body. `HttpRule` is typically specified as an
2073 // `google.api.http` annotation on the gRPC method. Each mapping specifies a
2074 // URL path template and an HTTP method. The path template may refer to one or
2075 // more fields in the gRPC request message, as long as each field is a
2076 // non-repeated field with a primitive (non-message) type. The path template
2077 // controls how fields of the request message are mapped to the URL path.
2078 // Example: service Messaging { rpc GetMessage(GetMessageRequest) returns
2079 // (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } }
2080 // message GetMessageRequest { string name = 1; // Mapped to URL path. }
2081 // message Message { string text = 1; // The resource content. } This enables
2082 // an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` -
2083 // gRPC: `GetMessage(name: "messages/123456")` Any fields in the request
2084 // message which are not bound by the path template automatically become HTTP
2085 // query parameters if there is no HTTP request body. For example: service
2086 // Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option
2087 // (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message
2088 // GetMessageRequest { message SubMessage { string subfield = 1; } string
2089 // message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL
2090 // query parameter `revision`. SubMessage sub = 3; // Mapped to URL query
2091 // parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as
2092 // below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC:
2093 // `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
2094 // "foo"))` Note that fields which are mapped to URL query parameters must have
2095 // a primitive type or a repeated primitive type or a non-repeated message
2096 // type. In the case of a repeated type, the parameter can be repeated in the
2097 // URL as `...?param=A&param=B`. In the case of a message type, each field of
2098 // the message is mapped to a separate parameter, such as
2099 // `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body,
2100 // the `body` field specifies the mapping. Consider a REST update method on the
2101 // message resource collection: service Messaging { rpc
2102 // UpdateMessage(UpdateMessageRequest) returns (Message) { option
2103 // (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" };
2104 // } } message UpdateMessageRequest { string message_id = 1; // mapped to the
2105 // URL Message message = 2; // mapped to the body } The following HTTP JSON to
2106 // RPC mapping is enabled, where the representation of the JSON in the request
2107 // body is determined by protos JSON encoding: - HTTP: `PATCH
2108 // /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id:
2109 // "123456" message { text: "Hi!" })` The special name `*` can be used in the
2110 // body mapping to define that every field not bound by the path template
2111 // should be mapped to the request body. This enables the following alternative
2112 // definition of the update method: service Messaging { rpc
2113 // UpdateMessage(Message) returns (Message) { option (google.api.http) = {
2114 // patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string
2115 // message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is
2116 // enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC:
2117 // `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*`
2118 // in the body mapping, it is not possible to have HTTP parameters, as all
2119 // fields not bound by the path end in the body. This makes this option more
2120 // rarely used in practice when defining REST APIs. The common usage of `*` is
2121 // in custom methods which don't use the URL at all for transferring data. It
2122 // is possible to define multiple HTTP methods for one RPC by using the
2123 // `additional_bindings` option. Example: service Messaging { rpc
2124 // GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) =
2125 // { get: "/v1/messages/{message_id}" additional_bindings { get:
2126 // "/v1/users/{user_id}/messages/{message_id}" } }; } } message
2127 // GetMessageRequest { string message_id = 1; string user_id = 2; } This
2128 // enables the following two alternative HTTP JSON to RPC mappings: - HTTP:
2129 // `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP:
2130 // `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me"
2131 // message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields
2132 // (recursive expansion nested messages in the request message) are classified
2133 // into three categories: - Fields referred by the path template. They are
2134 // passed via the URL path. - Fields referred by the HttpRule.body. They are
2135 // passed via the HTTP request body. - All other fields are passed via the URL
2136 // query parameters, and the parameter name is the field path in the request
2137 // message. A repeated field can be represented as multiple query parameters
2138 // under the same name. 2. If HttpRule.body is "*", there is no URL query
2139 // parameter, all fields are passed via URL path and HTTP request body. 3. If
2140 // HttpRule.body is omitted, there is no HTTP request body, all fields are
2141 // passed via URL path and URL query parameters. Path template syntax Template
2142 // = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*"
2143 // | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}"
2144 // ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*`
2145 // matches a single URL path segment. The syntax `**` matches zero or more URL
2146 // path segments, which must be the last part of the URL path except the
2147 // `Verb`. The syntax `Variable` matches part of the URL path as specified by
2148 // its template. A variable template must not contain other variables. If a
2149 // variable matches a single path segment, its template may be omitted, e.g.
2150 // `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal
2151 // text in the URL path. If the `LITERAL` contains any reserved character, such
2152 // characters should be percent-encoded before the matching. If a variable
2153 // contains exactly one path segment, such as "{var}" or "{var=*}", when
2154 // such a variable is expanded into a URL path on the client side, all
2155 // characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side
2156 // does the reverse decoding. Such variables show up in the Discovery Document
2157 // (https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a
2158 // variable contains multiple path segments, such as "{var=foo/*}" or
2159 // "{var=**}", when such a variable is expanded into a URL path on the client
2160 // side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The
2161 // server side does the reverse decoding, except "%2F" and "%2f" are left
2162 // unchanged. Such variables show up in the Discovery Document
2163 // (https://developers.google.com/discovery/v1/reference/apis) as `{+var}`.
2164 // Using gRPC API Service Configuration gRPC API Service Configuration (service
2165 // config) is a configuration language for configuring a gRPC service to become
2166 // a user-facing product. The service config is simply the YAML representation
2167 // of the `google.api.Service` proto message. As an alternative to annotating
2168 // your proto file, you can configure gRPC transcoding in your service config
2169 // YAML files. You do this by specifying a `HttpRule` that maps the gRPC method
2170 // to a REST endpoint, achieving the same effect as the proto annotation. This
2171 // can be particularly useful if you have a proto that is reused in multiple
2172 // services. Note that any transcoding specified in the service config will
2173 // override any matching transcoding configuration in the proto. The following
2174 // example selects a gRPC method and applies an `HttpRule` to it: http: rules:
2175 // - selector: example.v1.Messaging.GetMessage get:
2176 // /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding
2177 // is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion
2178 // must follow the proto3 specification
2179 // (https://developers.google.com/protocol-buffers/docs/proto3#json). While the
2180 // single segment variable follows the semantics of RFC 6570
2181 // (https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion,
2182 // the multi segment variable **does not** follow RFC 6570 Section 3.2.3
2183 // Reserved Expansion. The reason is that the Reserved Expansion does not
2184 // expand special characters like `?` and `#`, which would lead to invalid
2185 // URLs. As the result, gRPC Transcoding uses a custom encoding for multi
2186 // segment variables. The path variables **must not** refer to any repeated or
2187 // mapped field, because client libraries are not capable of handling such
2188 // variable expansion. The path variables **must not** capture the leading "/"
2189 // character. The reason is that the most common use case "{var}" does not
2190 // capture the leading "/" character. For consistency, all path variables must
2191 // share the same behavior. Repeated message fields must not be mapped to URL
2192 // query parameters, because no client library can support such complicated
2193 // mapping. If an API needs to use a JSON array for request or response body,
2194 // it can map the request or response body to a repeated field. However, some
2195 // gRPC Transcoding implementations may not support this feature.
2196 type HttpRule struct {
2197 // AdditionalBindings: Additional HTTP bindings for the selector. Nested
2198 // bindings must not contain an `additional_bindings` field themselves (that
2199 // is, the nesting may only be one level deep).
2200 AdditionalBindings []*HttpRule `json:"additionalBindings,omitempty"`
2201 // Body: The name of the request field whose value is mapped to the HTTP
2202 // request body, or `*` for mapping all request fields not captured by the path
2203 // pattern to the HTTP body, or omitted for not having any HTTP request body.
2204 // NOTE: the referred field must be present at the top-level of the request
2205 // message type.
2206 Body string `json:"body,omitempty"`
2207 // Custom: The custom pattern is used for specifying an HTTP method that is not
2208 // included in the `pattern` field, such as HEAD, or "*" to leave the HTTP
2209 // method unspecified for this rule. The wild-card rule is useful for services
2210 // that provide content to Web (HTML) clients.
2211 Custom *CustomHttpPattern `json:"custom,omitempty"`
2212 // Delete: Maps to HTTP DELETE. Used for deleting a resource.
2213 Delete string `json:"delete,omitempty"`
2214 // Get: Maps to HTTP GET. Used for listing and getting information about
2215 // resources.
2216 Get string `json:"get,omitempty"`
2217 // Patch: Maps to HTTP PATCH. Used for updating a resource.
2218 Patch string `json:"patch,omitempty"`
2219 // Post: Maps to HTTP POST. Used for creating a resource or performing an
2220 // action.
2221 Post string `json:"post,omitempty"`
2222 // Put: Maps to HTTP PUT. Used for replacing a resource.
2223 Put string `json:"put,omitempty"`
2224 // ResponseBody: Optional. The name of the response field whose value is mapped
2225 // to the HTTP response body. When omitted, the entire response message will be
2226 // used as the HTTP response body. NOTE: The referred field must be present at
2227 // the top-level of the response message type.
2228 ResponseBody string `json:"responseBody,omitempty"`
2229 // Selector: Selects a method to which this rule applies. Refer to selector for
2230 // syntax details.
2231 Selector string `json:"selector,omitempty"`
2232 // ForceSendFields is a list of field names (e.g. "AdditionalBindings") to
2233 // unconditionally include in API requests. By default, fields with empty or
2234 // default values are omitted from API requests. See
2235 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2236 // details.
2237 ForceSendFields []string `json:"-"`
2238 // NullFields is a list of field names (e.g. "AdditionalBindings") to include
2239 // in API requests with the JSON null value. By default, fields with empty
2240 // values are omitted from API requests. See
2241 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2242 NullFields []string `json:"-"`
2243 }
2244
2245 func (s HttpRule) MarshalJSON() ([]byte, error) {
2246 type NoMethod HttpRule
2247 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2248 }
2249
2250 // JavaSettings: Settings for Java client libraries.
2251 type JavaSettings struct {
2252 // Common: Some settings.
2253 Common *CommonLanguageSettings `json:"common,omitempty"`
2254 // LibraryPackage: The package name to use in Java. Clobbers the java_package
2255 // option set in the protobuf. This should be used **only** by APIs who have
2256 // already set the language_settings.java.package_name" field in gapic.yaml.
2257 // API teams should use the protobuf java_package option where possible.
2258 // Example of a YAML configuration:: publishing: library_settings:
2259 // java_settings: library_package: com.google.cloud.pubsub.v1
2260 LibraryPackage string `json:"libraryPackage,omitempty"`
2261 // ServiceClassNames: Configure the Java class name to use instead of the
2262 // service's for its corresponding generated GAPIC client. Keys are
2263 // fully-qualified service names as they appear in the protobuf (including the
2264 // full the language_settings.java.interface_names" field in gapic.yaml. API
2265 // teams should otherwise use the service name as it appears in the protobuf.
2266 // Example of a YAML configuration:: publishing: java_settings:
2267 // service_class_names: - google.pubsub.v1.Publisher: TopicAdmin -
2268 // google.pubsub.v1.Subscriber: SubscriptionAdmin
2269 ServiceClassNames map[string]string `json:"serviceClassNames,omitempty"`
2270 // ForceSendFields is a list of field names (e.g. "Common") to unconditionally
2271 // include in API requests. By default, fields with empty or default values are
2272 // omitted from API requests. See
2273 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2274 // details.
2275 ForceSendFields []string `json:"-"`
2276 // NullFields is a list of field names (e.g. "Common") to include in API
2277 // requests with the JSON null value. By default, fields with empty values are
2278 // omitted from API requests. See
2279 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2280 NullFields []string `json:"-"`
2281 }
2282
2283 func (s JavaSettings) MarshalJSON() ([]byte, error) {
2284 type NoMethod JavaSettings
2285 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2286 }
2287
2288 // JwtLocation: Specifies a location to extract JWT from an API request.
2289 type JwtLocation struct {
2290 // Cookie: Specifies cookie name to extract JWT token.
2291 Cookie string `json:"cookie,omitempty"`
2292 // Header: Specifies HTTP header name to extract JWT token.
2293 Header string `json:"header,omitempty"`
2294 // Query: Specifies URL query parameter name to extract JWT token.
2295 Query string `json:"query,omitempty"`
2296 // ValuePrefix: The value prefix. The value format is "value_prefix{token}"
2297 // Only applies to "in" header type. Must be empty for "in" query type. If not
2298 // empty, the header value has to match (case sensitive) this prefix. If not
2299 // matched, JWT will not be extracted. If matched, JWT will be extracted after
2300 // the prefix is removed. For example, for "Authorization: Bearer {JWT}",
2301 // value_prefix="Bearer " with a space at the end.
2302 ValuePrefix string `json:"valuePrefix,omitempty"`
2303 // ForceSendFields is a list of field names (e.g. "Cookie") to unconditionally
2304 // include in API requests. By default, fields with empty or default values are
2305 // omitted from API requests. See
2306 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2307 // details.
2308 ForceSendFields []string `json:"-"`
2309 // NullFields is a list of field names (e.g. "Cookie") to include in API
2310 // requests with the JSON null value. By default, fields with empty values are
2311 // omitted from API requests. See
2312 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2313 NullFields []string `json:"-"`
2314 }
2315
2316 func (s JwtLocation) MarshalJSON() ([]byte, error) {
2317 type NoMethod JwtLocation
2318 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2319 }
2320
2321 // LabelDescriptor: A description of a label.
2322 type LabelDescriptor struct {
2323 // Description: A human-readable description for the label.
2324 Description string `json:"description,omitempty"`
2325 // Key: The label key.
2326 Key string `json:"key,omitempty"`
2327 // ValueType: The type of data that can be assigned to the label.
2328 //
2329 // Possible values:
2330 // "STRING" - A variable-length string. This is the default.
2331 // "BOOL" - Boolean; true or false.
2332 // "INT64" - A 64-bit signed integer.
2333 ValueType string `json:"valueType,omitempty"`
2334 // ForceSendFields is a list of field names (e.g. "Description") to
2335 // unconditionally include in API requests. By default, fields with empty or
2336 // default values are omitted from API requests. See
2337 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2338 // details.
2339 ForceSendFields []string `json:"-"`
2340 // NullFields is a list of field names (e.g. "Description") to include in API
2341 // requests with the JSON null value. By default, fields with empty values are
2342 // omitted from API requests. See
2343 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2344 NullFields []string `json:"-"`
2345 }
2346
2347 func (s LabelDescriptor) MarshalJSON() ([]byte, error) {
2348 type NoMethod LabelDescriptor
2349 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2350 }
2351
2352 // ListConnectionsResponse: ListConnectionsResponse is the response to list
2353 // peering states for the given service and consumer project.
2354 type ListConnectionsResponse struct {
2355 // Connections: The list of Connections.
2356 Connections []*GoogleCloudServicenetworkingV1betaConnection `json:"connections,omitempty"`
2357
2358 // ServerResponse contains the HTTP response code and headers from the server.
2359 googleapi.ServerResponse `json:"-"`
2360 // ForceSendFields is a list of field names (e.g. "Connections") to
2361 // unconditionally include in API requests. By default, fields with empty or
2362 // default values are omitted from API requests. See
2363 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2364 // details.
2365 ForceSendFields []string `json:"-"`
2366 // NullFields is a list of field names (e.g. "Connections") to include in API
2367 // requests with the JSON null value. By default, fields with empty values are
2368 // omitted from API requests. See
2369 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2370 NullFields []string `json:"-"`
2371 }
2372
2373 func (s ListConnectionsResponse) MarshalJSON() ([]byte, error) {
2374 type NoMethod ListConnectionsResponse
2375 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2376 }
2377
2378 // LogDescriptor: A description of a log type. Example in YAML format: - name:
2379 // library.googleapis.com/activity_history description: The history of
2380 // borrowing and returning library items. display_name: Activity labels: - key:
2381 // /customer_id description: Identifier of a library customer
2382 type LogDescriptor struct {
2383 // Description: A human-readable description of this log. This information
2384 // appears in the documentation and can contain details.
2385 Description string `json:"description,omitempty"`
2386 // DisplayName: The human-readable name for this log. This information appears
2387 // on the user interface and should be concise.
2388 DisplayName string `json:"displayName,omitempty"`
2389 // Labels: The set of labels that are available to describe a specific log
2390 // entry. Runtime requests that contain labels not specified here are
2391 // considered invalid.
2392 Labels []*LabelDescriptor `json:"labels,omitempty"`
2393 // Name: The name of the log. It must be less than 512 characters long and can
2394 // include the following characters: upper- and lower-case alphanumeric
2395 // characters [A-Za-z0-9], and punctuation characters including slash,
2396 // underscore, hyphen, period [/_-.].
2397 Name string `json:"name,omitempty"`
2398 // ForceSendFields is a list of field names (e.g. "Description") to
2399 // unconditionally include in API requests. By default, fields with empty or
2400 // default values are omitted from API requests. See
2401 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2402 // details.
2403 ForceSendFields []string `json:"-"`
2404 // NullFields is a list of field names (e.g. "Description") to include in API
2405 // requests with the JSON null value. By default, fields with empty values are
2406 // omitted from API requests. See
2407 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2408 NullFields []string `json:"-"`
2409 }
2410
2411 func (s LogDescriptor) MarshalJSON() ([]byte, error) {
2412 type NoMethod LogDescriptor
2413 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2414 }
2415
2416 // Logging: Logging configuration of the service. The following example shows
2417 // how to configure logs to be sent to the producer and consumer projects. In
2418 // the example, the `activity_history` log is sent to both the producer and
2419 // consumer projects, whereas the `purchase_history` log is only sent to the
2420 // producer project. monitored_resources: - type: library.googleapis.com/branch
2421 // labels: - key: /city description: The city where the library branch is
2422 // located in. - key: /name description: The name of the branch. logs: - name:
2423 // activity_history labels: - key: /customer_id - name: purchase_history
2424 // logging: producer_destinations: - monitored_resource:
2425 // library.googleapis.com/branch logs: - activity_history - purchase_history
2426 // consumer_destinations: - monitored_resource: library.googleapis.com/branch
2427 // logs: - activity_history
2428 type Logging struct {
2429 // ConsumerDestinations: Logging configurations for sending logs to the
2430 // consumer project. There can be multiple consumer destinations, each one must
2431 // have a different monitored resource type. A log can be used in at most one
2432 // consumer destination.
2433 ConsumerDestinations []*LoggingDestination `json:"consumerDestinations,omitempty"`
2434 // ProducerDestinations: Logging configurations for sending logs to the
2435 // producer project. There can be multiple producer destinations, each one must
2436 // have a different monitored resource type. A log can be used in at most one
2437 // producer destination.
2438 ProducerDestinations []*LoggingDestination `json:"producerDestinations,omitempty"`
2439 // ForceSendFields is a list of field names (e.g. "ConsumerDestinations") to
2440 // unconditionally include in API requests. By default, fields with empty or
2441 // default values are omitted from API requests. See
2442 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2443 // details.
2444 ForceSendFields []string `json:"-"`
2445 // NullFields is a list of field names (e.g. "ConsumerDestinations") to include
2446 // in API requests with the JSON null value. By default, fields with empty
2447 // values are omitted from API requests. See
2448 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2449 NullFields []string `json:"-"`
2450 }
2451
2452 func (s Logging) MarshalJSON() ([]byte, error) {
2453 type NoMethod Logging
2454 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2455 }
2456
2457 // LoggingDestination: Configuration of a specific logging destination (the
2458 // producer project or the consumer project).
2459 type LoggingDestination struct {
2460 // Logs: Names of the logs to be sent to this destination. Each name must be
2461 // defined in the Service.logs section. If the log name is not a domain scoped
2462 // name, it will be automatically prefixed with the service name followed by
2463 // "/".
2464 Logs []string `json:"logs,omitempty"`
2465 // MonitoredResource: The monitored resource type. The type must be defined in
2466 // the Service.monitored_resources section.
2467 MonitoredResource string `json:"monitoredResource,omitempty"`
2468 // ForceSendFields is a list of field names (e.g. "Logs") to unconditionally
2469 // include in API requests. By default, fields with empty or default values are
2470 // omitted from API requests. See
2471 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2472 // details.
2473 ForceSendFields []string `json:"-"`
2474 // NullFields is a list of field names (e.g. "Logs") to include in API requests
2475 // with the JSON null value. By default, fields with empty values are omitted
2476 // from API requests. See
2477 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2478 NullFields []string `json:"-"`
2479 }
2480
2481 func (s LoggingDestination) MarshalJSON() ([]byte, error) {
2482 type NoMethod LoggingDestination
2483 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2484 }
2485
2486 // LongRunning: Describes settings to use when generating API methods that use
2487 // the long-running operation pattern. All default values below are from those
2488 // used in the client library generators (e.g. Java
2489 // (https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
2490 type LongRunning struct {
2491 // InitialPollDelay: Initial delay after which the first poll request will be
2492 // made. Default value: 5 seconds.
2493 InitialPollDelay string `json:"initialPollDelay,omitempty"`
2494 // MaxPollDelay: Maximum time between two subsequent poll requests. Default
2495 // value: 45 seconds.
2496 MaxPollDelay string `json:"maxPollDelay,omitempty"`
2497 // PollDelayMultiplier: Multiplier to gradually increase delay between
2498 // subsequent polls until it reaches max_poll_delay. Default value: 1.5.
2499 PollDelayMultiplier float64 `json:"pollDelayMultiplier,omitempty"`
2500 // TotalPollTimeout: Total polling timeout. Default value: 5 minutes.
2501 TotalPollTimeout string `json:"totalPollTimeout,omitempty"`
2502 // ForceSendFields is a list of field names (e.g. "InitialPollDelay") to
2503 // unconditionally include in API requests. By default, fields with empty or
2504 // default values are omitted from API requests. See
2505 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2506 // details.
2507 ForceSendFields []string `json:"-"`
2508 // NullFields is a list of field names (e.g. "InitialPollDelay") to include in
2509 // API requests with the JSON null value. By default, fields with empty values
2510 // are omitted from API requests. See
2511 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2512 NullFields []string `json:"-"`
2513 }
2514
2515 func (s LongRunning) MarshalJSON() ([]byte, error) {
2516 type NoMethod LongRunning
2517 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2518 }
2519
2520 func (s *LongRunning) UnmarshalJSON(data []byte) error {
2521 type NoMethod LongRunning
2522 var s1 struct {
2523 PollDelayMultiplier gensupport.JSONFloat64 `json:"pollDelayMultiplier"`
2524 *NoMethod
2525 }
2526 s1.NoMethod = (*NoMethod)(s)
2527 if err := json.Unmarshal(data, &s1); err != nil {
2528 return err
2529 }
2530 s.PollDelayMultiplier = float64(s1.PollDelayMultiplier)
2531 return nil
2532 }
2533
2534 // Method: Method represents a method of an API interface. New usages of this
2535 // message as an alternative to MethodDescriptorProto are strongly discouraged.
2536 // This message does not reliability preserve all information necessary to
2537 // model the schema and preserve semantics. Instead make use of
2538 // FileDescriptorSet which preserves the necessary information.
2539 type Method struct {
2540 // Edition: The source edition string, only valid when syntax is
2541 // SYNTAX_EDITIONS. This field should be ignored, instead the edition should be
2542 // inherited from Api. This is similar to Field and EnumValue.
2543 Edition string `json:"edition,omitempty"`
2544 // Name: The simple name of this method.
2545 Name string `json:"name,omitempty"`
2546 // Options: Any metadata attached to the method.
2547 Options []*Option `json:"options,omitempty"`
2548 // RequestStreaming: If true, the request is streamed.
2549 RequestStreaming bool `json:"requestStreaming,omitempty"`
2550 // RequestTypeUrl: A URL of the input message type.
2551 RequestTypeUrl string `json:"requestTypeUrl,omitempty"`
2552 // ResponseStreaming: If true, the response is streamed.
2553 ResponseStreaming bool `json:"responseStreaming,omitempty"`
2554 // ResponseTypeUrl: The URL of the output message type.
2555 ResponseTypeUrl string `json:"responseTypeUrl,omitempty"`
2556 // Syntax: The source syntax of this method. This field should be ignored,
2557 // instead the syntax should be inherited from Api. This is similar to Field
2558 // and EnumValue.
2559 //
2560 // Possible values:
2561 // "SYNTAX_PROTO2" - Syntax `proto2`.
2562 // "SYNTAX_PROTO3" - Syntax `proto3`.
2563 // "SYNTAX_EDITIONS" - Syntax `editions`.
2564 Syntax string `json:"syntax,omitempty"`
2565 // ForceSendFields is a list of field names (e.g. "Edition") to unconditionally
2566 // include in API requests. By default, fields with empty or default values are
2567 // omitted from API requests. See
2568 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2569 // details.
2570 ForceSendFields []string `json:"-"`
2571 // NullFields is a list of field names (e.g. "Edition") to include in API
2572 // requests with the JSON null value. By default, fields with empty values are
2573 // omitted from API requests. See
2574 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2575 NullFields []string `json:"-"`
2576 }
2577
2578 func (s Method) MarshalJSON() ([]byte, error) {
2579 type NoMethod Method
2580 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2581 }
2582
2583 // MethodPolicy: Defines policies applying to an RPC method.
2584 type MethodPolicy struct {
2585 // RequestPolicies: Policies that are applicable to the request message.
2586 RequestPolicies []*FieldPolicy `json:"requestPolicies,omitempty"`
2587 // Selector: Selects a method to which these policies should be enforced, for
2588 // example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector
2589 // for syntax details. NOTE: This field must not be set in the proto
2590 // annotation. It will be automatically filled by the service config compiler .
2591 Selector string `json:"selector,omitempty"`
2592 // ForceSendFields is a list of field names (e.g. "RequestPolicies") to
2593 // unconditionally include in API requests. By default, fields with empty or
2594 // default values are omitted from API requests. See
2595 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2596 // details.
2597 ForceSendFields []string `json:"-"`
2598 // NullFields is a list of field names (e.g. "RequestPolicies") to include in
2599 // API requests with the JSON null value. By default, fields with empty values
2600 // are omitted from API requests. See
2601 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2602 NullFields []string `json:"-"`
2603 }
2604
2605 func (s MethodPolicy) MarshalJSON() ([]byte, error) {
2606 type NoMethod MethodPolicy
2607 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2608 }
2609
2610 // MethodSettings: Describes the generator configuration for a method.
2611 type MethodSettings struct {
2612 // AutoPopulatedFields: List of top-level fields of the request message, that
2613 // should be automatically populated by the client libraries based on their
2614 // (google.api.field_info).format. Currently supported format: UUID4. Example
2615 // of a YAML configuration: publishing: method_settings: - selector:
2616 // google.example.v1.ExampleService.CreateExample auto_populated_fields: -
2617 // request_id
2618 AutoPopulatedFields []string `json:"autoPopulatedFields,omitempty"`
2619 // Batching: Batching configuration for an API method in client libraries.
2620 // Example of a YAML configuration: publishing: method_settings: - selector:
2621 // google.example.v1.ExampleService.BatchCreateExample batching:
2622 // element_count_threshold: 1000 request_byte_threshold: 100000000
2623 // delay_threshold_millis: 10
2624 Batching *BatchingConfigProto `json:"batching,omitempty"`
2625 // LongRunning: Describes settings to use for long-running operations when
2626 // generating API methods for RPCs. Complements RPCs that use the annotations
2627 // in google/longrunning/operations.proto. Example of a YAML configuration::
2628 // publishing: method_settings: - selector:
2629 // google.cloud.speech.v2.Speech.BatchRecognize long_running:
2630 // initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5
2631 // max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 minutes
2632 LongRunning *LongRunning `json:"longRunning,omitempty"`
2633 // Selector: The fully qualified name of the method, for which the options
2634 // below apply. This is used to find the method to apply the options. Example:
2635 // publishing: method_settings: - selector:
2636 // google.storage.control.v2.StorageControl.CreateFolder # method settings for
2637 // CreateFolder...
2638 Selector string `json:"selector,omitempty"`
2639 // ForceSendFields is a list of field names (e.g. "AutoPopulatedFields") to
2640 // unconditionally include in API requests. By default, fields with empty or
2641 // default values are omitted from API requests. See
2642 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2643 // details.
2644 ForceSendFields []string `json:"-"`
2645 // NullFields is a list of field names (e.g. "AutoPopulatedFields") to include
2646 // in API requests with the JSON null value. By default, fields with empty
2647 // values are omitted from API requests. See
2648 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2649 NullFields []string `json:"-"`
2650 }
2651
2652 func (s MethodSettings) MarshalJSON() ([]byte, error) {
2653 type NoMethod MethodSettings
2654 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2655 }
2656
2657 // MetricDescriptor: Defines a metric type and its schema. Once a metric
2658 // descriptor is created, deleting or altering it stops data collection and
2659 // makes the metric type's existing data unusable.
2660 type MetricDescriptor struct {
2661 // Description: A detailed description of the metric, which can be used in
2662 // documentation.
2663 Description string `json:"description,omitempty"`
2664 // DisplayName: A concise name for the metric, which can be displayed in user
2665 // interfaces. Use sentence case without an ending period, for example "Request
2666 // count". This field is optional but it is recommended to be set for any
2667 // metrics associated with user-visible concepts, such as Quota.
2668 DisplayName string `json:"displayName,omitempty"`
2669 // Labels: The set of labels that can be used to describe a specific instance
2670 // of this metric type. For example, the
2671 // `appengine.googleapis.com/http/server/response_latencies` metric type has a
2672 // label for the HTTP response code, `response_code`, so you can look at
2673 // latencies for successful responses or just for responses that failed.
2674 Labels []*LabelDescriptor `json:"labels,omitempty"`
2675 // LaunchStage: Optional. The launch stage of the metric definition.
2676 //
2677 // Possible values:
2678 // "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.
2679 // "UNIMPLEMENTED" - The feature is not yet implemented. Users can not use
2680 // it.
2681 // "PRELAUNCH" - Prelaunch features are hidden from users and are only
2682 // visible internally.
2683 // "EARLY_ACCESS" - Early Access features are limited to a closed group of
2684 // testers. To use these features, you must sign up in advance and sign a
2685 // Trusted Tester agreement (which includes confidentiality provisions). These
2686 // features may be unstable, changed in backward-incompatible ways, and are not
2687 // guaranteed to be released.
2688 // "ALPHA" - Alpha is a limited availability test for releases before they
2689 // are cleared for widespread use. By Alpha, all significant design issues are
2690 // resolved and we are in the process of verifying functionality. Alpha
2691 // customers need to apply for access, agree to applicable terms, and have
2692 // their projects allowlisted. Alpha releases don't have to be feature
2693 // complete, no SLAs are provided, and there are no technical support
2694 // obligations, but they will be far enough along that customers can actually
2695 // use them in test environments or for limited-use tests -- just like they
2696 // would in normal production cases.
2697 // "BETA" - Beta is the point at which we are ready to open a release for any
2698 // customer to use. There are no SLA or technical support obligations in a Beta
2699 // release. Products will be complete from a feature perspective, but may have
2700 // some open outstanding issues. Beta releases are suitable for limited
2701 // production use cases.
2702 // "GA" - GA features are open to all developers and are considered stable
2703 // and fully qualified for production use.
2704 // "DEPRECATED" - Deprecated features are scheduled to be shut down and
2705 // removed. For more information, see the "Deprecation Policy" section of our
2706 // [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud
2707 // Platform Subject to the Deprecation
2708 // Policy](https://cloud.google.com/terms/deprecation) documentation.
2709 LaunchStage string `json:"launchStage,omitempty"`
2710 // Metadata: Optional. Metadata which can be used to guide usage of the metric.
2711 Metadata *MetricDescriptorMetadata `json:"metadata,omitempty"`
2712 // MetricKind: Whether the metric records instantaneous values, changes to a
2713 // value, etc. Some combinations of `metric_kind` and `value_type` might not be
2714 // supported.
2715 //
2716 // Possible values:
2717 // "METRIC_KIND_UNSPECIFIED" - Do not use this default value.
2718 // "GAUGE" - An instantaneous measurement of a value.
2719 // "DELTA" - The change in a value during a time interval.
2720 // "CUMULATIVE" - A value accumulated over a time interval. Cumulative
2721 // measurements in a time series should have the same start time and increasing
2722 // end times, until an event resets the cumulative value to zero and sets a new
2723 // start time for the following points.
2724 MetricKind string `json:"metricKind,omitempty"`
2725 // MonitoredResourceTypes: Read-only. If present, then a time series, which is
2726 // identified partially by a metric type and a MonitoredResourceDescriptor,
2727 // that is associated with this metric type can only be associated with one of
2728 // the monitored resource types listed here.
2729 MonitoredResourceTypes []string `json:"monitoredResourceTypes,omitempty"`
2730 // Name: The resource name of the metric descriptor.
2731 Name string `json:"name,omitempty"`
2732 // Type: The metric type, including its DNS name prefix. The type is not
2733 // URL-encoded. All user-defined metric types have the DNS name
2734 // `custom.googleapis.com` or `external.googleapis.com`. Metric types should
2735 // use a natural hierarchical grouping. For example:
2736 // "custom.googleapis.com/invoice/paid/amount"
2737 // "external.googleapis.com/prometheus/up"
2738 // "appengine.googleapis.com/http/server/response_latencies"
2739 Type string `json:"type,omitempty"`
2740 // Unit: The units in which the metric value is reported. It is only applicable
2741 // if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit`
2742 // defines the representation of the stored metric values. Different systems
2743 // might scale the values to be more easily displayed (so a value of `0.02kBy`
2744 // _might_ be displayed as `20By`, and a value of `3523kBy` _might_ be
2745 // displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of
2746 // the metric is always in thousands of bytes, no matter how it might be
2747 // displayed. If you want a custom metric to record the exact number of
2748 // CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose
2749 // `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses
2750 // 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if
2751 // you want a custom metric to record data in a more granular way, you can
2752 // create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then
2753 // write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and
2754 // write `11.723` (which is `12005/1024`). The supported units are a subset of
2755 // The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html)
2756 // standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second *
2757 // `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)**
2758 // * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) *
2759 // `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) *
2760 // `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12)
2761 // * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto
2762 // (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti`
2763 // tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these
2764 // connectors: * `/` division or ratio (as an infix operator). For examples,
2765 // `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in
2766 // a metric `unit`; rates should always be computed at query time from the
2767 // underlying cumulative or delta value). * `.` multiplication or composition
2768 // (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar
2769 // for a unit is as follows: Expression = Component { "." Component } { "/"
2770 // Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] |
2771 // Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just
2772 // a comment if it follows a `UNIT`. If the annotation is used alone, then the
2773 // unit is equivalent to `1`. For examples, `{request}/s == 1/s`,
2774 // `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable
2775 // ASCII characters not containing `{` or `}`. * `1` represents a unitary
2776 // dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of
2777 // 1, such as in `1/s`. It is typically used when none of the basic units are
2778 // appropriate. For example, "new users per day" can be represented as `1/d` or
2779 // `{new-users}/d` (and a metric value `5` would mean "5 new users).
2780 // Alternatively, "thousands of page views per day" would be represented as
2781 // `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would
2782 // mean "5300 page views per day"). * `%` represents dimensionless value of
2783 // 1/100, and annotates values giving a percentage (so the metric values are
2784 // typically in the range of 0..100, and a metric value `3` means "3 percent").
2785 // * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1,
2786 // that will be multiplied by 100 and displayed as a percentage (so a metric
2787 // value `0.03` means "3 percent").
2788 Unit string `json:"unit,omitempty"`
2789 // ValueType: Whether the measurement is an integer, a floating-point number,
2790 // etc. Some combinations of `metric_kind` and `value_type` might not be
2791 // supported.
2792 //
2793 // Possible values:
2794 // "VALUE_TYPE_UNSPECIFIED" - Do not use this default value.
2795 // "BOOL" - The value is a boolean. This value type can be used only if the
2796 // metric kind is `GAUGE`.
2797 // "INT64" - The value is a signed 64-bit integer.
2798 // "DOUBLE" - The value is a double precision floating point number.
2799 // "STRING" - The value is a text string. This value type can be used only if
2800 // the metric kind is `GAUGE`.
2801 // "DISTRIBUTION" - The value is a `Distribution`.
2802 // "MONEY" - The value is money.
2803 ValueType string `json:"valueType,omitempty"`
2804 // ForceSendFields is a list of field names (e.g. "Description") to
2805 // unconditionally include in API requests. By default, fields with empty or
2806 // default values are omitted from API requests. See
2807 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2808 // details.
2809 ForceSendFields []string `json:"-"`
2810 // NullFields is a list of field names (e.g. "Description") to include in API
2811 // requests with the JSON null value. By default, fields with empty values are
2812 // omitted from API requests. See
2813 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2814 NullFields []string `json:"-"`
2815 }
2816
2817 func (s MetricDescriptor) MarshalJSON() ([]byte, error) {
2818 type NoMethod MetricDescriptor
2819 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2820 }
2821
2822 // MetricDescriptorMetadata: Additional annotations that can be used to guide
2823 // the usage of a metric.
2824 type MetricDescriptorMetadata struct {
2825 // IngestDelay: The delay of data points caused by ingestion. Data points older
2826 // than this age are guaranteed to be ingested and available to be read,
2827 // excluding data loss due to errors.
2828 IngestDelay string `json:"ingestDelay,omitempty"`
2829 // LaunchStage: Deprecated. Must use the MetricDescriptor.launch_stage instead.
2830 //
2831 // Possible values:
2832 // "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.
2833 // "UNIMPLEMENTED" - The feature is not yet implemented. Users can not use
2834 // it.
2835 // "PRELAUNCH" - Prelaunch features are hidden from users and are only
2836 // visible internally.
2837 // "EARLY_ACCESS" - Early Access features are limited to a closed group of
2838 // testers. To use these features, you must sign up in advance and sign a
2839 // Trusted Tester agreement (which includes confidentiality provisions). These
2840 // features may be unstable, changed in backward-incompatible ways, and are not
2841 // guaranteed to be released.
2842 // "ALPHA" - Alpha is a limited availability test for releases before they
2843 // are cleared for widespread use. By Alpha, all significant design issues are
2844 // resolved and we are in the process of verifying functionality. Alpha
2845 // customers need to apply for access, agree to applicable terms, and have
2846 // their projects allowlisted. Alpha releases don't have to be feature
2847 // complete, no SLAs are provided, and there are no technical support
2848 // obligations, but they will be far enough along that customers can actually
2849 // use them in test environments or for limited-use tests -- just like they
2850 // would in normal production cases.
2851 // "BETA" - Beta is the point at which we are ready to open a release for any
2852 // customer to use. There are no SLA or technical support obligations in a Beta
2853 // release. Products will be complete from a feature perspective, but may have
2854 // some open outstanding issues. Beta releases are suitable for limited
2855 // production use cases.
2856 // "GA" - GA features are open to all developers and are considered stable
2857 // and fully qualified for production use.
2858 // "DEPRECATED" - Deprecated features are scheduled to be shut down and
2859 // removed. For more information, see the "Deprecation Policy" section of our
2860 // [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud
2861 // Platform Subject to the Deprecation
2862 // Policy](https://cloud.google.com/terms/deprecation) documentation.
2863 LaunchStage string `json:"launchStage,omitempty"`
2864 // SamplePeriod: The sampling period of metric data points. For metrics which
2865 // are written periodically, consecutive data points are stored at this time
2866 // interval, excluding data loss due to errors. Metrics with a higher
2867 // granularity have a smaller sampling period.
2868 SamplePeriod string `json:"samplePeriod,omitempty"`
2869 // TimeSeriesResourceHierarchyLevel: The scope of the timeseries data of the
2870 // metric.
2871 //
2872 // Possible values:
2873 // "TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED" - Do not use this
2874 // default value.
2875 // "PROJECT" - Scopes a metric to a project.
2876 // "ORGANIZATION" - Scopes a metric to an organization.
2877 // "FOLDER" - Scopes a metric to a folder.
2878 TimeSeriesResourceHierarchyLevel []string `json:"timeSeriesResourceHierarchyLevel,omitempty"`
2879 // ForceSendFields is a list of field names (e.g. "IngestDelay") to
2880 // unconditionally include in API requests. By default, fields with empty or
2881 // default values are omitted from API requests. See
2882 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2883 // details.
2884 ForceSendFields []string `json:"-"`
2885 // NullFields is a list of field names (e.g. "IngestDelay") to include in API
2886 // requests with the JSON null value. By default, fields with empty values are
2887 // omitted from API requests. See
2888 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2889 NullFields []string `json:"-"`
2890 }
2891
2892 func (s MetricDescriptorMetadata) MarshalJSON() ([]byte, error) {
2893 type NoMethod MetricDescriptorMetadata
2894 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2895 }
2896
2897 // MetricRule: Bind API methods to metrics. Binding a method to a metric causes
2898 // that metric's configured quota behaviors to apply to the method call.
2899 type MetricRule struct {
2900 // MetricCosts: Metrics to update when the selected methods are called, and the
2901 // associated cost applied to each metric. The key of the map is the metric
2902 // name, and the values are the amount increased for the metric against which
2903 // the quota limits are defined. The value must not be negative.
2904 MetricCosts map[string]string `json:"metricCosts,omitempty"`
2905 // Selector: Selects the methods to which this rule applies. Refer to selector
2906 // for syntax details.
2907 Selector string `json:"selector,omitempty"`
2908 // ForceSendFields is a list of field names (e.g. "MetricCosts") to
2909 // unconditionally include in API requests. By default, fields with empty or
2910 // default values are omitted from API requests. See
2911 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2912 // details.
2913 ForceSendFields []string `json:"-"`
2914 // NullFields is a list of field names (e.g. "MetricCosts") to include in API
2915 // requests with the JSON null value. By default, fields with empty values are
2916 // omitted from API requests. See
2917 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2918 NullFields []string `json:"-"`
2919 }
2920
2921 func (s MetricRule) MarshalJSON() ([]byte, error) {
2922 type NoMethod MetricRule
2923 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2924 }
2925
2926 // Mixin: Declares an API Interface to be included in this interface. The
2927 // including interface must redeclare all the methods from the included
2928 // interface, but documentation and options are inherited as follows: - If
2929 // after comment and whitespace stripping, the documentation string of the
2930 // redeclared method is empty, it will be inherited from the original method. -
2931 // Each annotation belonging to the service config (http, visibility) which is
2932 // not set in the redeclared method will be inherited. - If an http annotation
2933 // is inherited, the path pattern will be modified as follows. Any version
2934 // prefix will be replaced by the version of the including interface plus the
2935 // root path if specified. Example of a simple mixin: package google.acl.v1;
2936 // service AccessControl { // Get the underlying ACL object. rpc
2937 // GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get =
2938 // "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage {
2939 // // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc
2940 // GetData(GetDataRequest) returns (Data) { option (google.api.http).get =
2941 // "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name:
2942 // google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The
2943 // mixin construct implies that all methods in `AccessControl` are also
2944 // declared with same name and request/response types in `Storage`. A
2945 // documentation generator or annotation processor will see the effective
2946 // `Storage.GetAcl` method after inheriting documentation and annotations as
2947 // follows: service Storage { // Get the underlying ACL object. rpc
2948 // GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get =
2949 // "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern
2950 // changed from `v1` to `v2`. If the `root` field in the mixin is specified, it
2951 // should be a relative path under which inherited HTTP paths are placed.
2952 // Example: apis: - name: google.storage.v2.Storage mixins: - name:
2953 // google.acl.v1.AccessControl root: acls This implies the following inherited
2954 // HTTP annotation: service Storage { // Get the underlying ACL object. rpc
2955 // GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get =
2956 // "/v2/acls/{resource=**}:getAcl"; } ... }
2957 type Mixin struct {
2958 // Name: The fully qualified name of the interface which is included.
2959 Name string `json:"name,omitempty"`
2960 // Root: If non-empty specifies a path under which inherited HTTP paths are
2961 // rooted.
2962 Root string `json:"root,omitempty"`
2963 // ForceSendFields is a list of field names (e.g. "Name") to unconditionally
2964 // include in API requests. By default, fields with empty or default values are
2965 // omitted from API requests. See
2966 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
2967 // details.
2968 ForceSendFields []string `json:"-"`
2969 // NullFields is a list of field names (e.g. "Name") to include in API requests
2970 // with the JSON null value. By default, fields with empty values are omitted
2971 // from API requests. See
2972 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
2973 NullFields []string `json:"-"`
2974 }
2975
2976 func (s Mixin) MarshalJSON() ([]byte, error) {
2977 type NoMethod Mixin
2978 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
2979 }
2980
2981 // MonitoredResourceDescriptor: An object that describes the schema of a
2982 // MonitoredResource object using a type name and a set of labels. For example,
2983 // the monitored resource descriptor for Google Compute Engine VM instances has
2984 // a type of "gce_instance" and specifies the use of the labels
2985 // "instance_id" and "zone" to identify particular VM instances. Different
2986 // APIs can support different monitored resource types. APIs generally provide
2987 // a `list` method that returns the monitored resource descriptors used by the
2988 // API.
2989 type MonitoredResourceDescriptor struct {
2990 // Description: Optional. A detailed description of the monitored resource type
2991 // that might be used in documentation.
2992 Description string `json:"description,omitempty"`
2993 // DisplayName: Optional. A concise name for the monitored resource type that
2994 // might be displayed in user interfaces. It should be a Title Cased Noun
2995 // Phrase, without any article or other determiners. For example, "Google
2996 // Cloud SQL Database".
2997 DisplayName string `json:"displayName,omitempty"`
2998 // Labels: Required. A set of labels used to describe instances of this
2999 // monitored resource type. For example, an individual Google Cloud SQL
3000 // database is identified by values for the labels "database_id" and
3001 // "zone".
3002 Labels []*LabelDescriptor `json:"labels,omitempty"`
3003 // LaunchStage: Optional. The launch stage of the monitored resource
3004 // definition.
3005 //
3006 // Possible values:
3007 // "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.
3008 // "UNIMPLEMENTED" - The feature is not yet implemented. Users can not use
3009 // it.
3010 // "PRELAUNCH" - Prelaunch features are hidden from users and are only
3011 // visible internally.
3012 // "EARLY_ACCESS" - Early Access features are limited to a closed group of
3013 // testers. To use these features, you must sign up in advance and sign a
3014 // Trusted Tester agreement (which includes confidentiality provisions). These
3015 // features may be unstable, changed in backward-incompatible ways, and are not
3016 // guaranteed to be released.
3017 // "ALPHA" - Alpha is a limited availability test for releases before they
3018 // are cleared for widespread use. By Alpha, all significant design issues are
3019 // resolved and we are in the process of verifying functionality. Alpha
3020 // customers need to apply for access, agree to applicable terms, and have
3021 // their projects allowlisted. Alpha releases don't have to be feature
3022 // complete, no SLAs are provided, and there are no technical support
3023 // obligations, but they will be far enough along that customers can actually
3024 // use them in test environments or for limited-use tests -- just like they
3025 // would in normal production cases.
3026 // "BETA" - Beta is the point at which we are ready to open a release for any
3027 // customer to use. There are no SLA or technical support obligations in a Beta
3028 // release. Products will be complete from a feature perspective, but may have
3029 // some open outstanding issues. Beta releases are suitable for limited
3030 // production use cases.
3031 // "GA" - GA features are open to all developers and are considered stable
3032 // and fully qualified for production use.
3033 // "DEPRECATED" - Deprecated features are scheduled to be shut down and
3034 // removed. For more information, see the "Deprecation Policy" section of our
3035 // [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud
3036 // Platform Subject to the Deprecation
3037 // Policy](https://cloud.google.com/terms/deprecation) documentation.
3038 LaunchStage string `json:"launchStage,omitempty"`
3039 // Name: Optional. The resource name of the monitored resource descriptor:
3040 // "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type}
3041 // is the value of the `type` field in this object and {project_id} is a
3042 // project ID that provides API-specific context for accessing the type. APIs
3043 // that do not use project information can use the resource name format
3044 // "monitoredResourceDescriptors/{type}".
3045 Name string `json:"name,omitempty"`
3046 // Type: Required. The monitored resource type. For example, the type
3047 // "cloudsql_database" represents databases in Google Cloud SQL. For a list
3048 // of types, see Monitored resource types
3049 // (https://cloud.google.com/monitoring/api/resources) and Logging resource
3050 // types (https://cloud.google.com/logging/docs/api/v2/resource-list).
3051 Type string `json:"type,omitempty"`
3052 // ForceSendFields is a list of field names (e.g. "Description") to
3053 // unconditionally include in API requests. By default, fields with empty or
3054 // default values are omitted from API requests. See
3055 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3056 // details.
3057 ForceSendFields []string `json:"-"`
3058 // NullFields is a list of field names (e.g. "Description") to include in API
3059 // requests with the JSON null value. By default, fields with empty values are
3060 // omitted from API requests. See
3061 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3062 NullFields []string `json:"-"`
3063 }
3064
3065 func (s MonitoredResourceDescriptor) MarshalJSON() ([]byte, error) {
3066 type NoMethod MonitoredResourceDescriptor
3067 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3068 }
3069
3070 // Monitoring: Monitoring configuration of the service. The example below shows
3071 // how to configure monitored resources and metrics for monitoring. In the
3072 // example, a monitored resource and two metrics are defined. The
3073 // `library.googleapis.com/book/returned_count` metric is sent to both producer
3074 // and consumer projects, whereas the `library.googleapis.com/book/num_overdue`
3075 // metric is only sent to the consumer project. monitored_resources: - type:
3076 // library.googleapis.com/Branch display_name: "Library Branch" description: "A
3077 // branch of a library." launch_stage: GA labels: - key: resource_container
3078 // description: "The Cloud container (ie. project id) for the Branch." - key:
3079 // location description: "The location of the library branch." - key: branch_id
3080 // description: "The id of the branch." metrics: - name:
3081 // library.googleapis.com/book/returned_count display_name: "Books Returned"
3082 // description: "The count of books that have been returned." launch_stage: GA
3083 // metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id
3084 // description: "The id of the customer." - name:
3085 // library.googleapis.com/book/num_overdue display_name: "Books Overdue"
3086 // description: "The current number of overdue books." launch_stage: GA
3087 // metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id
3088 // description: "The id of the customer." monitoring: producer_destinations: -
3089 // monitored_resource: library.googleapis.com/Branch metrics: -
3090 // library.googleapis.com/book/returned_count consumer_destinations: -
3091 // monitored_resource: library.googleapis.com/Branch metrics: -
3092 // library.googleapis.com/book/returned_count -
3093 // library.googleapis.com/book/num_overdue
3094 type Monitoring struct {
3095 // ConsumerDestinations: Monitoring configurations for sending metrics to the
3096 // consumer project. There can be multiple consumer destinations. A monitored
3097 // resource type may appear in multiple monitoring destinations if different
3098 // aggregations are needed for different sets of metrics associated with that
3099 // monitored resource type. A monitored resource and metric pair may only be
3100 // used once in the Monitoring configuration.
3101 ConsumerDestinations []*MonitoringDestination `json:"consumerDestinations,omitempty"`
3102 // ProducerDestinations: Monitoring configurations for sending metrics to the
3103 // producer project. There can be multiple producer destinations. A monitored
3104 // resource type may appear in multiple monitoring destinations if different
3105 // aggregations are needed for different sets of metrics associated with that
3106 // monitored resource type. A monitored resource and metric pair may only be
3107 // used once in the Monitoring configuration.
3108 ProducerDestinations []*MonitoringDestination `json:"producerDestinations,omitempty"`
3109 // ForceSendFields is a list of field names (e.g. "ConsumerDestinations") to
3110 // unconditionally include in API requests. By default, fields with empty or
3111 // default values are omitted from API requests. See
3112 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3113 // details.
3114 ForceSendFields []string `json:"-"`
3115 // NullFields is a list of field names (e.g. "ConsumerDestinations") to include
3116 // in API requests with the JSON null value. By default, fields with empty
3117 // values are omitted from API requests. See
3118 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3119 NullFields []string `json:"-"`
3120 }
3121
3122 func (s Monitoring) MarshalJSON() ([]byte, error) {
3123 type NoMethod Monitoring
3124 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3125 }
3126
3127 // MonitoringDestination: Configuration of a specific monitoring destination
3128 // (the producer project or the consumer project).
3129 type MonitoringDestination struct {
3130 // Metrics: Types of the metrics to report to this monitoring destination. Each
3131 // type must be defined in Service.metrics section.
3132 Metrics []string `json:"metrics,omitempty"`
3133 // MonitoredResource: The monitored resource type. The type must be defined in
3134 // Service.monitored_resources section.
3135 MonitoredResource string `json:"monitoredResource,omitempty"`
3136 // ForceSendFields is a list of field names (e.g. "Metrics") to unconditionally
3137 // include in API requests. By default, fields with empty or default values are
3138 // omitted from API requests. See
3139 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3140 // details.
3141 ForceSendFields []string `json:"-"`
3142 // NullFields is a list of field names (e.g. "Metrics") to include in API
3143 // requests with the JSON null value. By default, fields with empty values are
3144 // omitted from API requests. See
3145 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3146 NullFields []string `json:"-"`
3147 }
3148
3149 func (s MonitoringDestination) MarshalJSON() ([]byte, error) {
3150 type NoMethod MonitoringDestination
3151 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3152 }
3153
3154 // NodeSettings: Settings for Node client libraries.
3155 type NodeSettings struct {
3156 // Common: Some settings.
3157 Common *CommonLanguageSettings `json:"common,omitempty"`
3158 // ForceSendFields is a list of field names (e.g. "Common") to unconditionally
3159 // include in API requests. By default, fields with empty or default values are
3160 // omitted from API requests. See
3161 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3162 // details.
3163 ForceSendFields []string `json:"-"`
3164 // NullFields is a list of field names (e.g. "Common") to include in API
3165 // requests with the JSON null value. By default, fields with empty values are
3166 // omitted from API requests. See
3167 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3168 NullFields []string `json:"-"`
3169 }
3170
3171 func (s NodeSettings) MarshalJSON() ([]byte, error) {
3172 type NoMethod NodeSettings
3173 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3174 }
3175
3176 // OAuthRequirements: OAuth scopes are a way to define data and permissions on
3177 // data. For example, there are scopes defined for "Read-only access to Google
3178 // Calendar" and "Access to Cloud Platform". Users can consent to a scope for
3179 // an application, giving it permission to access that data on their behalf.
3180 // OAuth scope specifications should be fairly coarse grained; a user will need
3181 // to see and understand the text description of what your scope means. In most
3182 // cases: use one or at most two OAuth scopes for an entire family of products.
3183 // If your product has multiple APIs, you should probably be sharing the OAuth
3184 // scope across all of those APIs. When you need finer grained OAuth consent
3185 // screens: talk with your product management about how developers will use
3186 // them in practice. Please note that even though each of the canonical scopes
3187 // is enough for a request to be accepted and passed to the backend, a request
3188 // can still fail due to the backend requiring additional scopes or
3189 // permissions.
3190 type OAuthRequirements struct {
3191 // CanonicalScopes: The list of publicly documented OAuth scopes that are
3192 // allowed access. An OAuth token containing any of these scopes will be
3193 // accepted. Example: canonical_scopes:
3194 // https://www.googleapis.com/auth/calendar,
3195 // https://www.googleapis.com/auth/calendar.read
3196 CanonicalScopes string `json:"canonicalScopes,omitempty"`
3197 // ForceSendFields is a list of field names (e.g. "CanonicalScopes") to
3198 // unconditionally include in API requests. By default, fields with empty or
3199 // default values are omitted from API requests. See
3200 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3201 // details.
3202 ForceSendFields []string `json:"-"`
3203 // NullFields is a list of field names (e.g. "CanonicalScopes") to include in
3204 // API requests with the JSON null value. By default, fields with empty values
3205 // are omitted from API requests. See
3206 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3207 NullFields []string `json:"-"`
3208 }
3209
3210 func (s OAuthRequirements) MarshalJSON() ([]byte, error) {
3211 type NoMethod OAuthRequirements
3212 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3213 }
3214
3215 // Operation: This resource represents a long-running operation that is the
3216 // result of a network API call.
3217 type Operation struct {
3218 // Done: If the value is `false`, it means the operation is still in progress.
3219 // If `true`, the operation is completed, and either `error` or `response` is
3220 // available.
3221 Done bool `json:"done,omitempty"`
3222 // Error: The error result of the operation in case of failure or cancellation.
3223 Error *Status `json:"error,omitempty"`
3224 // Metadata: Service-specific metadata associated with the operation. It
3225 // typically contains progress information and common metadata such as create
3226 // time. Some services might not provide such metadata. Any method that returns
3227 // a long-running operation should document the metadata type, if any.
3228 Metadata googleapi.RawMessage `json:"metadata,omitempty"`
3229 // Name: The server-assigned name, which is only unique within the same service
3230 // that originally returns it. If you use the default HTTP mapping, the `name`
3231 // should be a resource name ending with `operations/{unique_id}`.
3232 Name string `json:"name,omitempty"`
3233 // Response: The normal, successful response of the operation. If the original
3234 // method returns no data on success, such as `Delete`, the response is
3235 // `google.protobuf.Empty`. If the original method is standard
3236 // `Get`/`Create`/`Update`, the response should be the resource. For other
3237 // methods, the response should have the type `XxxResponse`, where `Xxx` is the
3238 // original method name. For example, if the original method name is
3239 // `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
3240 Response googleapi.RawMessage `json:"response,omitempty"`
3241
3242 // ServerResponse contains the HTTP response code and headers from the server.
3243 googleapi.ServerResponse `json:"-"`
3244 // ForceSendFields is a list of field names (e.g. "Done") to unconditionally
3245 // include in API requests. By default, fields with empty or default values are
3246 // omitted from API requests. See
3247 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3248 // details.
3249 ForceSendFields []string `json:"-"`
3250 // NullFields is a list of field names (e.g. "Done") to include in API requests
3251 // with the JSON null value. By default, fields with empty values are omitted
3252 // from API requests. See
3253 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3254 NullFields []string `json:"-"`
3255 }
3256
3257 func (s Operation) MarshalJSON() ([]byte, error) {
3258 type NoMethod Operation
3259 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3260 }
3261
3262 // Option: A protocol buffer option, which can be attached to a message, field,
3263 // enumeration, etc. New usages of this message as an alternative to
3264 // FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions,
3265 // ServiceOptions, or MethodOptions are strongly discouraged.
3266 type Option struct {
3267 // Name: The option's name. For protobuf built-in options (options defined in
3268 // descriptor.proto), this is the short name. For example, "map_entry". For
3269 // custom options, it should be the fully-qualified name. For example,
3270 // "google.api.http".
3271 Name string `json:"name,omitempty"`
3272 // Value: The option's value packed in an Any message. If the value is a
3273 // primitive, the corresponding wrapper type defined in
3274 // google/protobuf/wrappers.proto should be used. If the value is an enum, it
3275 // should be stored as an int32 value using the google.protobuf.Int32Value
3276 // type.
3277 Value googleapi.RawMessage `json:"value,omitempty"`
3278 // ForceSendFields is a list of field names (e.g. "Name") to unconditionally
3279 // include in API requests. By default, fields with empty or default values are
3280 // omitted from API requests. See
3281 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3282 // details.
3283 ForceSendFields []string `json:"-"`
3284 // NullFields is a list of field names (e.g. "Name") to include in API requests
3285 // with the JSON null value. By default, fields with empty values are omitted
3286 // from API requests. See
3287 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3288 NullFields []string `json:"-"`
3289 }
3290
3291 func (s Option) MarshalJSON() ([]byte, error) {
3292 type NoMethod Option
3293 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3294 }
3295
3296 // Page: Represents a documentation page. A page can contain subpages to
3297 // represent nested documentation set structure.
3298 type Page struct {
3299 // Content: The Markdown content of the page. You can use ```(== include {path}
3300 // ==)``` to include content from a Markdown file. The content can be used to
3301 // produce the documentation page such as HTML format page.
3302 Content string `json:"content,omitempty"`
3303 // Name: The name of the page. It will be used as an identity of the page to
3304 // generate URI of the page, text of the link to this page in navigation, etc.
3305 // The full page name (start from the root page name to this page concatenated
3306 // with `.`) can be used as reference to the page in your documentation. For
3307 // example: pages: - name: Tutorial content: (== include tutorial.md ==)
3308 // subpages: - name: Java content: (== include tutorial_java.md ==) You can
3309 // reference `Java` page using Markdown reference link syntax: `Java`.
3310 Name string `json:"name,omitempty"`
3311 // Subpages: Subpages of this page. The order of subpages specified here will
3312 // be honored in the generated docset.
3313 Subpages []*Page `json:"subpages,omitempty"`
3314 // ForceSendFields is a list of field names (e.g. "Content") to unconditionally
3315 // include in API requests. By default, fields with empty or default values are
3316 // omitted from API requests. See
3317 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3318 // details.
3319 ForceSendFields []string `json:"-"`
3320 // NullFields is a list of field names (e.g. "Content") to include in API
3321 // requests with the JSON null value. By default, fields with empty values are
3322 // omitted from API requests. See
3323 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3324 NullFields []string `json:"-"`
3325 }
3326
3327 func (s Page) MarshalJSON() ([]byte, error) {
3328 type NoMethod Page
3329 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3330 }
3331
3332 // PartialDeleteConnectionMetadata: Metadata provided through GetOperation
3333 // request for the LRO generated by Partial Delete Connection API
3334 type PartialDeleteConnectionMetadata struct {
3335 }
3336
3337 // PeeredDnsDomain: DNS domain suffix for which requests originating in the
3338 // producer VPC network are resolved in the associated consumer VPC network.
3339 type PeeredDnsDomain struct {
3340 // DnsSuffix: The DNS domain name suffix e.g. `example.com.`. Cloud DNS
3341 // requires that a DNS suffix ends with a trailing dot.
3342 DnsSuffix string `json:"dnsSuffix,omitempty"`
3343 // Name: Required. User assigned name for this resource. Must be unique within
3344 // the consumer network. The name must be 1-63 characters long, must begin with
3345 // a letter, end with a letter or digit, and only contain lowercase letters,
3346 // digits or dashes.
3347 Name string `json:"name,omitempty"`
3348 // ForceSendFields is a list of field names (e.g. "DnsSuffix") to
3349 // unconditionally include in API requests. By default, fields with empty or
3350 // default values are omitted from API requests. See
3351 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3352 // details.
3353 ForceSendFields []string `json:"-"`
3354 // NullFields is a list of field names (e.g. "DnsSuffix") to include in API
3355 // requests with the JSON null value. By default, fields with empty values are
3356 // omitted from API requests. See
3357 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3358 NullFields []string `json:"-"`
3359 }
3360
3361 func (s PeeredDnsDomain) MarshalJSON() ([]byte, error) {
3362 type NoMethod PeeredDnsDomain
3363 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3364 }
3365
3366 // PeeredDnsDomainMetadata: Metadata provided through GetOperation request for
3367 // the LRO generated by CreatePeeredDnsDomain API.
3368 type PeeredDnsDomainMetadata struct {
3369 }
3370
3371 // PhpSettings: Settings for Php client libraries.
3372 type PhpSettings struct {
3373 // Common: Some settings.
3374 Common *CommonLanguageSettings `json:"common,omitempty"`
3375 // LibraryPackage: The package name to use in Php. Clobbers the php_namespace
3376 // option set in the protobuf. This should be used **only** by APIs who have
3377 // already set the language_settings.php.package_name" field in gapic.yaml. API
3378 // teams should use the protobuf php_namespace option where possible. Example
3379 // of a YAML configuration:: publishing: library_settings: php_settings:
3380 // library_package: Google\Cloud\PubSub\V1
3381 LibraryPackage string `json:"libraryPackage,omitempty"`
3382 // ForceSendFields is a list of field names (e.g. "Common") to unconditionally
3383 // include in API requests. By default, fields with empty or default values are
3384 // omitted from API requests. See
3385 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3386 // details.
3387 ForceSendFields []string `json:"-"`
3388 // NullFields is a list of field names (e.g. "Common") to include in API
3389 // requests with the JSON null value. By default, fields with empty values are
3390 // omitted from API requests. See
3391 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3392 NullFields []string `json:"-"`
3393 }
3394
3395 func (s PhpSettings) MarshalJSON() ([]byte, error) {
3396 type NoMethod PhpSettings
3397 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3398 }
3399
3400 // PolicyBinding: Grouping of IAM role and IAM member.
3401 type PolicyBinding struct {
3402 // Member: Required. Member to bind the role with. See
3403 // /iam/docs/reference/rest/v1/Policy#Binding for how to format each member.
3404 // Eg. - user:[email protected] -
3405 // serviceAccount:[email protected]
3406 Member string `json:"member,omitempty"`
3407 // Role: Required. Role to apply. Only allowlisted roles can be used at the
3408 // specified granularity. The role must be one of the following: -
3409 // 'roles/container.hostServiceAgentUser' applied on the shared VPC host
3410 // project - 'roles/compute.securityAdmin' applied on the shared VPC host
3411 // project - 'roles/compute.networkAdmin' applied on the shared VPC host
3412 // project - 'roles/tpu.xpnAgent' applied on the shared VPC host project -
3413 // 'roles/dns.admin' applied on the shared VPC host project -
3414 // 'roles/logging.admin' applied on the shared VPC host project -
3415 // 'roles/monitoring.viewer' applied on the shared VPC host project -
3416 // 'roles/servicemanagement.quotaViewer' applied on the shared VPC host project
3417 Role string `json:"role,omitempty"`
3418 // ForceSendFields is a list of field names (e.g. "Member") to unconditionally
3419 // include in API requests. By default, fields with empty or default values are
3420 // omitted from API requests. See
3421 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3422 // details.
3423 ForceSendFields []string `json:"-"`
3424 // NullFields is a list of field names (e.g. "Member") to include in API
3425 // requests with the JSON null value. By default, fields with empty values are
3426 // omitted from API requests. See
3427 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3428 NullFields []string `json:"-"`
3429 }
3430
3431 func (s PolicyBinding) MarshalJSON() ([]byte, error) {
3432 type NoMethod PolicyBinding
3433 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3434 }
3435
3436 // Publishing: This message configures the settings for publishing Google Cloud
3437 // Client libraries (https://cloud.google.com/apis/docs/cloud-client-libraries)
3438 // generated from the service config.
3439 type Publishing struct {
3440 // ApiShortName: Used as a tracking tag when collecting data about the APIs
3441 // developer relations artifacts like docs, packages delivered to package
3442 // managers, etc. Example: "speech".
3443 ApiShortName string `json:"apiShortName,omitempty"`
3444 // CodeownerGithubTeams: GitHub teams to be added to CODEOWNERS in the
3445 // directory in GitHub containing source code for the client libraries for this
3446 // API.
3447 CodeownerGithubTeams []string `json:"codeownerGithubTeams,omitempty"`
3448 // DocTagPrefix: A prefix used in sample code when demarking regions to be
3449 // included in documentation.
3450 DocTagPrefix string `json:"docTagPrefix,omitempty"`
3451 // DocumentationUri: Link to product home page. Example:
3452 // https://cloud.google.com/asset-inventory/docs/overview
3453 DocumentationUri string `json:"documentationUri,omitempty"`
3454 // GithubLabel: GitHub label to apply to issues and pull requests opened for
3455 // this API.
3456 GithubLabel string `json:"githubLabel,omitempty"`
3457 // LibrarySettings: Client library settings. If the same version string appears
3458 // multiple times in this list, then the last one wins. Settings from earlier
3459 // settings with the same version string are discarded.
3460 LibrarySettings []*ClientLibrarySettings `json:"librarySettings,omitempty"`
3461 // MethodSettings: A list of API method settings, e.g. the behavior for methods
3462 // that use the long-running operation pattern.
3463 MethodSettings []*MethodSettings `json:"methodSettings,omitempty"`
3464 // NewIssueUri: Link to a *public* URI where users can report issues. Example:
3465 // https://issuetracker.google.com/issues/new?component=190865&template=1161103
3466 NewIssueUri string `json:"newIssueUri,omitempty"`
3467 // Organization: For whom the client library is being published.
3468 //
3469 // Possible values:
3470 // "CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED" - Not useful.
3471 // "CLOUD" - Google Cloud Platform Org.
3472 // "ADS" - Ads (Advertising) Org.
3473 // "PHOTOS" - Photos Org.
3474 // "STREET_VIEW" - Street View Org.
3475 // "SHOPPING" - Shopping Org.
3476 // "GEO" - Geo Org.
3477 // "GENERATIVE_AI" - Generative AI - https://developers.generativeai.google
3478 // "HEALTH" - Health Org.
3479 Organization string `json:"organization,omitempty"`
3480 // ProtoReferenceDocumentationUri: Optional link to proto reference
3481 // documentation. Example:
3482 // https://cloud.google.com/pubsub/lite/docs/reference/rpc
3483 ProtoReferenceDocumentationUri string `json:"protoReferenceDocumentationUri,omitempty"`
3484 // RestReferenceDocumentationUri: Optional link to REST reference
3485 // documentation. Example:
3486 // https://cloud.google.com/pubsub/lite/docs/reference/rest
3487 RestReferenceDocumentationUri string `json:"restReferenceDocumentationUri,omitempty"`
3488 // ForceSendFields is a list of field names (e.g. "ApiShortName") to
3489 // unconditionally include in API requests. By default, fields with empty or
3490 // default values are omitted from API requests. See
3491 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3492 // details.
3493 ForceSendFields []string `json:"-"`
3494 // NullFields is a list of field names (e.g. "ApiShortName") to include in API
3495 // requests with the JSON null value. By default, fields with empty values are
3496 // omitted from API requests. See
3497 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3498 NullFields []string `json:"-"`
3499 }
3500
3501 func (s Publishing) MarshalJSON() ([]byte, error) {
3502 type NoMethod Publishing
3503 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3504 }
3505
3506 // PythonSettings: Settings for Python client libraries.
3507 type PythonSettings struct {
3508 // Common: Some settings.
3509 Common *CommonLanguageSettings `json:"common,omitempty"`
3510 // ExperimentalFeatures: Experimental features to be included during client
3511 // library generation.
3512 ExperimentalFeatures *ExperimentalFeatures `json:"experimentalFeatures,omitempty"`
3513 // ForceSendFields is a list of field names (e.g. "Common") to unconditionally
3514 // include in API requests. By default, fields with empty or default values are
3515 // omitted from API requests. See
3516 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3517 // details.
3518 ForceSendFields []string `json:"-"`
3519 // NullFields is a list of field names (e.g. "Common") to include in API
3520 // requests with the JSON null value. By default, fields with empty values are
3521 // omitted from API requests. See
3522 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3523 NullFields []string `json:"-"`
3524 }
3525
3526 func (s PythonSettings) MarshalJSON() ([]byte, error) {
3527 type NoMethod PythonSettings
3528 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3529 }
3530
3531 // Quota: Quota configuration helps to achieve fairness and budgeting in
3532 // service usage. The metric based quota configuration works this way: - The
3533 // service configuration defines a set of metrics. - For API calls, the
3534 // quota.metric_rules maps methods to metrics with corresponding costs. - The
3535 // quota.limits defines limits on the metrics, which will be used for quota
3536 // checks at runtime. An example quota configuration in yaml format: quota:
3537 // limits: - name: apiWriteQpsPerProject metric:
3538 // library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for
3539 // consumer projects values: STANDARD: 10000 (The metric rules bind all methods
3540 // to the read_calls metric, except for the UpdateBook and DeleteBook methods.
3541 // These two methods are mapped to the write_calls metric, with the UpdateBook
3542 // method consuming at twice rate as the DeleteBook method.) metric_rules: -
3543 // selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector:
3544 // google.example.library.v1.LibraryService.UpdateBook metric_costs:
3545 // library.googleapis.com/write_calls: 2 - selector:
3546 // google.example.library.v1.LibraryService.DeleteBook metric_costs:
3547 // library.googleapis.com/write_calls: 1 Corresponding Metric definition:
3548 // metrics: - name: library.googleapis.com/read_calls display_name: Read
3549 // requests metric_kind: DELTA value_type: INT64 - name:
3550 // library.googleapis.com/write_calls display_name: Write requests metric_kind:
3551 // DELTA value_type: INT64
3552 type Quota struct {
3553 // Limits: List of QuotaLimit definitions for the service.
3554 Limits []*QuotaLimit `json:"limits,omitempty"`
3555 // MetricRules: List of MetricRule definitions, each one mapping a selected
3556 // method to one or more metrics.
3557 MetricRules []*MetricRule `json:"metricRules,omitempty"`
3558 // ForceSendFields is a list of field names (e.g. "Limits") to unconditionally
3559 // include in API requests. By default, fields with empty or default values are
3560 // omitted from API requests. See
3561 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3562 // details.
3563 ForceSendFields []string `json:"-"`
3564 // NullFields is a list of field names (e.g. "Limits") to include in API
3565 // requests with the JSON null value. By default, fields with empty values are
3566 // omitted from API requests. See
3567 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3568 NullFields []string `json:"-"`
3569 }
3570
3571 func (s Quota) MarshalJSON() ([]byte, error) {
3572 type NoMethod Quota
3573 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3574 }
3575
3576 // QuotaLimit: `QuotaLimit` defines a specific limit that applies over a
3577 // specified duration for a limit type. There can be at most one limit for a
3578 // duration and limit type combination defined within a `QuotaGroup`.
3579 type QuotaLimit struct {
3580 // DefaultLimit: Default number of tokens that can be consumed during the
3581 // specified duration. This is the number of tokens assigned when a client
3582 // application developer activates the service for his/her project. Specifying
3583 // a value of 0 will block all requests. This can be used if you are
3584 // provisioning quota to selected consumers and blocking others. Similarly, a
3585 // value of -1 will indicate an unlimited quota. No other negative values are
3586 // allowed. Used by group-based quotas only.
3587 DefaultLimit int64 `json:"defaultLimit,omitempty,string"`
3588 // Description: Optional. User-visible, extended description for this quota
3589 // limit. Should be used only when more context is needed to understand this
3590 // limit than provided by the limit's display name (see: `display_name`).
3591 Description string `json:"description,omitempty"`
3592 // DisplayName: User-visible display name for this limit. Optional. If not set,
3593 // the UI will provide a default display name based on the quota configuration.
3594 // This field can be used to override the default display name generated from
3595 // the configuration.
3596 DisplayName string `json:"displayName,omitempty"`
3597 // Duration: Duration of this limit in textual notation. Must be "100s" or
3598 // "1d". Used by group-based quotas only.
3599 Duration string `json:"duration,omitempty"`
3600 // FreeTier: Free tier value displayed in the Developers Console for this
3601 // limit. The free tier is the number of tokens that will be subtracted from
3602 // the billed amount when billing is enabled. This field can only be set on a
3603 // limit with duration "1d", in a billable group; it is invalid on any other
3604 // limit. If this field is not set, it defaults to 0, indicating that there is
3605 // no free tier for this service. Used by group-based quotas only.
3606 FreeTier int64 `json:"freeTier,omitempty,string"`
3607 // MaxLimit: Maximum number of tokens that can be consumed during the specified
3608 // duration. Client application developers can override the default limit up to
3609 // this maximum. If specified, this value cannot be set to a value less than
3610 // the default limit. If not specified, it is set to the default limit. To
3611 // allow clients to apply overrides with no upper bound, set this to -1,
3612 // indicating unlimited maximum quota. Used by group-based quotas only.
3613 MaxLimit int64 `json:"maxLimit,omitempty,string"`
3614 // Metric: The name of the metric this quota limit applies to. The quota limits
3615 // with the same metric will be checked together during runtime. The metric
3616 // must be defined within the service config.
3617 Metric string `json:"metric,omitempty"`
3618 // Name: Name of the quota limit. The name must be provided, and it must be
3619 // unique within the service. The name can only include alphanumeric characters
3620 // as well as '-'. The maximum length of the limit name is 64 characters.
3621 Name string `json:"name,omitempty"`
3622 // Unit: Specify the unit of the quota limit. It uses the same syntax as
3623 // MetricDescriptor.unit. The supported unit kinds are determined by the quota
3624 // backend system. Here are some examples: * "1/min/{project}" for quota per
3625 // minute per project. Note: the order of unit components is insignificant. The
3626 // "1" at the beginning is required to follow the metric unit syntax.
3627 Unit string `json:"unit,omitempty"`
3628 // Values: Tiered limit values. You must specify this as a key:value pair, with
3629 // an integer value that is the maximum number of requests allowed for the
3630 // specified unit. Currently only STANDARD is supported.
3631 Values map[string]string `json:"values,omitempty"`
3632 // ForceSendFields is a list of field names (e.g. "DefaultLimit") to
3633 // unconditionally include in API requests. By default, fields with empty or
3634 // default values are omitted from API requests. See
3635 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3636 // details.
3637 ForceSendFields []string `json:"-"`
3638 // NullFields is a list of field names (e.g. "DefaultLimit") to include in API
3639 // requests with the JSON null value. By default, fields with empty values are
3640 // omitted from API requests. See
3641 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3642 NullFields []string `json:"-"`
3643 }
3644
3645 func (s QuotaLimit) MarshalJSON() ([]byte, error) {
3646 type NoMethod QuotaLimit
3647 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3648 }
3649
3650 // Range: Represents a found unused range.
3651 type Range struct {
3652 // IpCidrRange: CIDR range in "10.x.x.x/y" format that is within the allocated
3653 // ranges and currently unused.
3654 IpCidrRange string `json:"ipCidrRange,omitempty"`
3655 // Network: In the Shared VPC host project, the VPC network that's peered with
3656 // the consumer network. For example:
3657 // `projects/1234321/global/networks/host-network`
3658 Network string `json:"network,omitempty"`
3659 // ForceSendFields is a list of field names (e.g. "IpCidrRange") to
3660 // unconditionally include in API requests. By default, fields with empty or
3661 // default values are omitted from API requests. See
3662 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3663 // details.
3664 ForceSendFields []string `json:"-"`
3665 // NullFields is a list of field names (e.g. "IpCidrRange") to include in API
3666 // requests with the JSON null value. By default, fields with empty values are
3667 // omitted from API requests. See
3668 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3669 NullFields []string `json:"-"`
3670 }
3671
3672 func (s Range) MarshalJSON() ([]byte, error) {
3673 type NoMethod Range
3674 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3675 }
3676
3677 // RemoveDnsRecordSetMetadata: Metadata provided through GetOperation request
3678 // for the LRO generated by RemoveDnsRecordSet API
3679 type RemoveDnsRecordSetMetadata struct {
3680 }
3681
3682 // RemoveDnsRecordSetResponse: Blank message response type for
3683 // RemoveDnsRecordSet API
3684 type RemoveDnsRecordSetResponse struct {
3685 }
3686
3687 // RemoveDnsZoneMetadata: Metadata provided through GetOperation request for
3688 // the LRO generated by RemoveDnsZone API
3689 type RemoveDnsZoneMetadata struct {
3690 }
3691
3692 // RemoveDnsZoneResponse: Blank message response type for RemoveDnsZone API
3693 type RemoveDnsZoneResponse struct {
3694 }
3695
3696 // Route: Represents a route that was created or discovered by a private access
3697 // management service.
3698 type Route struct {
3699 // DestRange: Destination CIDR range that this route applies to.
3700 DestRange string `json:"destRange,omitempty"`
3701 // Name: Route name. See https://cloud.google.com/vpc/docs/routes
3702 Name string `json:"name,omitempty"`
3703 // Network: Fully-qualified URL of the VPC network in the producer host tenant
3704 // project that this route applies to. For example:
3705 // `projects/123456/global/networks/host-network`
3706 Network string `json:"network,omitempty"`
3707 // NextHopGateway: Fully-qualified URL of the gateway that should handle
3708 // matching packets that this route applies to. For example:
3709 // `projects/123456/global/gateways/default-internet-gateway`
3710 NextHopGateway string `json:"nextHopGateway,omitempty"`
3711 // ForceSendFields is a list of field names (e.g. "DestRange") to
3712 // unconditionally include in API requests. By default, fields with empty or
3713 // default values are omitted from API requests. See
3714 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3715 // details.
3716 ForceSendFields []string `json:"-"`
3717 // NullFields is a list of field names (e.g. "DestRange") to include in API
3718 // requests with the JSON null value. By default, fields with empty values are
3719 // omitted from API requests. See
3720 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3721 NullFields []string `json:"-"`
3722 }
3723
3724 func (s Route) MarshalJSON() ([]byte, error) {
3725 type NoMethod Route
3726 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3727 }
3728
3729 // RubySettings: Settings for Ruby client libraries.
3730 type RubySettings struct {
3731 // Common: Some settings.
3732 Common *CommonLanguageSettings `json:"common,omitempty"`
3733 // ForceSendFields is a list of field names (e.g. "Common") to unconditionally
3734 // include in API requests. By default, fields with empty or default values are
3735 // omitted from API requests. See
3736 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3737 // details.
3738 ForceSendFields []string `json:"-"`
3739 // NullFields is a list of field names (e.g. "Common") to include in API
3740 // requests with the JSON null value. By default, fields with empty values are
3741 // omitted from API requests. See
3742 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3743 NullFields []string `json:"-"`
3744 }
3745
3746 func (s RubySettings) MarshalJSON() ([]byte, error) {
3747 type NoMethod RubySettings
3748 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3749 }
3750
3751 // SearchRangeRequest: Request to search for an unused range within allocated
3752 // ranges.
3753 type SearchRangeRequest struct {
3754 // IpPrefixLength: Required. The prefix length of the IP range. Use usual CIDR
3755 // range notation. For example, '30' to find unused x.x.x.x/30 CIDR range.
3756 // Actual range will be determined using allocated range for the consumer
3757 // peered network and returned in the result.
3758 IpPrefixLength int64 `json:"ipPrefixLength,omitempty"`
3759 // Network: Network name in the consumer project. This network must have been
3760 // already peered with a shared VPC network using CreateConnection method. Must
3761 // be in a form 'projects/{project}/global/networks/{network}'. {project} is a
3762 // project number, as in '12345' {network} is network name.
3763 Network string `json:"network,omitempty"`
3764 // ForceSendFields is a list of field names (e.g. "IpPrefixLength") to
3765 // unconditionally include in API requests. By default, fields with empty or
3766 // default values are omitted from API requests. See
3767 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3768 // details.
3769 ForceSendFields []string `json:"-"`
3770 // NullFields is a list of field names (e.g. "IpPrefixLength") to include in
3771 // API requests with the JSON null value. By default, fields with empty values
3772 // are omitted from API requests. See
3773 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3774 NullFields []string `json:"-"`
3775 }
3776
3777 func (s SearchRangeRequest) MarshalJSON() ([]byte, error) {
3778 type NoMethod SearchRangeRequest
3779 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3780 }
3781
3782 type SecondaryIpRange struct {
3783 // IpCidrRange: Secondary IP CIDR range in `x.x.x.x/y` format.
3784 IpCidrRange string `json:"ipCidrRange,omitempty"`
3785 // RangeName: Name of the secondary IP range.
3786 RangeName string `json:"rangeName,omitempty"`
3787 // ForceSendFields is a list of field names (e.g. "IpCidrRange") to
3788 // unconditionally include in API requests. By default, fields with empty or
3789 // default values are omitted from API requests. See
3790 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3791 // details.
3792 ForceSendFields []string `json:"-"`
3793 // NullFields is a list of field names (e.g. "IpCidrRange") to include in API
3794 // requests with the JSON null value. By default, fields with empty values are
3795 // omitted from API requests. See
3796 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3797 NullFields []string `json:"-"`
3798 }
3799
3800 func (s SecondaryIpRange) MarshalJSON() ([]byte, error) {
3801 type NoMethod SecondaryIpRange
3802 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3803 }
3804
3805 // SelectiveGapicGeneration: This message is used to configure the generation
3806 // of a subset of the RPCs in a service for client libraries. Note: This
3807 // feature should not be used in most cases.
3808 type SelectiveGapicGeneration struct {
3809 // GenerateOmittedAsInternal: Setting this to true indicates to the client
3810 // generators that methods that would be excluded from the generation should
3811 // instead be generated in a way that indicates these methods should not be
3812 // consumed by end users. How this is expressed is up to individual language
3813 // implementations to decide. Some examples may be: added annotations,
3814 // obfuscated identifiers, or other language idiomatic patterns.
3815 GenerateOmittedAsInternal bool `json:"generateOmittedAsInternal,omitempty"`
3816 // Methods: An allowlist of the fully qualified names of RPCs that should be
3817 // included on public client surfaces.
3818 Methods []string `json:"methods,omitempty"`
3819 // ForceSendFields is a list of field names (e.g. "GenerateOmittedAsInternal")
3820 // to unconditionally include in API requests. By default, fields with empty or
3821 // default values are omitted from API requests. See
3822 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3823 // details.
3824 ForceSendFields []string `json:"-"`
3825 // NullFields is a list of field names (e.g. "GenerateOmittedAsInternal") to
3826 // include in API requests with the JSON null value. By default, fields with
3827 // empty values are omitted from API requests. See
3828 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3829 NullFields []string `json:"-"`
3830 }
3831
3832 func (s SelectiveGapicGeneration) MarshalJSON() ([]byte, error) {
3833 type NoMethod SelectiveGapicGeneration
3834 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3835 }
3836
3837 // Service: `Service` is the root object of Google API service configuration
3838 // (service config). It describes the basic information about a logical
3839 // service, such as the service name and the user-facing title, and delegates
3840 // other aspects to sub-sections. Each sub-section is either a proto message or
3841 // a repeated proto message that configures a specific aspect, such as auth.
3842 // For more information, see each proto message definition. Example: type:
3843 // google.api.Service name: calendar.googleapis.com title: Google Calendar API
3844 // apis: - name: google.calendar.v3.Calendar visibility: rules: - selector:
3845 // "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector:
3846 // "google.calendar.v3.*" address: calendar.example.com authentication:
3847 // providers: - id: google_calendar_auth jwks_uri:
3848 // https://www.googleapis.com/oauth2/v1/certs issuer:
3849 // https://securetoken.google.com rules: - selector: "*" requirements:
3850 // provider_id: google_calendar_auth
3851 type Service struct {
3852 // Apis: A list of API interfaces exported by this service. Only the `name`
3853 // field of the google.protobuf.Api needs to be provided by the configuration
3854 // author, as the remaining fields will be derived from the IDL during the
3855 // normalization process. It is an error to specify an API interface here which
3856 // cannot be resolved against the associated IDL files.
3857 Apis []*Api `json:"apis,omitempty"`
3858 // Aspects: Configuration aspects. This is a repeated field to allow multiple
3859 // aspects to be configured. The kind field in each ConfigAspect specifies the
3860 // type of aspect. The spec field contains the configuration for that aspect.
3861 // The schema for the spec field is defined by the backend service owners.
3862 Aspects []*Aspect `json:"aspects,omitempty"`
3863 // Authentication: Auth configuration.
3864 Authentication *Authentication `json:"authentication,omitempty"`
3865 // Backend: API backend configuration.
3866 Backend *Backend `json:"backend,omitempty"`
3867 // Billing: Billing configuration.
3868 Billing *Billing `json:"billing,omitempty"`
3869 // ConfigVersion: Obsolete. Do not use. This field has no semantic meaning. The
3870 // service config compiler always sets this field to `3`.
3871 ConfigVersion int64 `json:"configVersion,omitempty"`
3872 // Context: Context configuration.
3873 Context *Context `json:"context,omitempty"`
3874 // Control: Configuration for the service control plane.
3875 Control *Control `json:"control,omitempty"`
3876 // CustomError: Custom error configuration.
3877 CustomError *CustomError `json:"customError,omitempty"`
3878 // Documentation: Additional API documentation.
3879 Documentation *Documentation `json:"documentation,omitempty"`
3880 // Endpoints: Configuration for network endpoints. If this is empty, then an
3881 // endpoint with the same name as the service is automatically generated to
3882 // service all defined APIs.
3883 Endpoints []*Endpoint `json:"endpoints,omitempty"`
3884 // Enums: A list of all enum types included in this API service. Enums
3885 // referenced directly or indirectly by the `apis` are automatically included.
3886 // Enums which are not referenced but shall be included should be listed here
3887 // by name by the configuration author. Example: enums: - name:
3888 // google.someapi.v1.SomeEnum
3889 Enums []*Enum `json:"enums,omitempty"`
3890 // Http: HTTP configuration.
3891 Http *Http `json:"http,omitempty"`
3892 // Id: A unique ID for a specific instance of this message, typically assigned
3893 // by the client for tracking purpose. Must be no longer than 63 characters and
3894 // only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the
3895 // server may choose to generate one instead.
3896 Id string `json:"id,omitempty"`
3897 // Logging: Logging configuration.
3898 Logging *Logging `json:"logging,omitempty"`
3899 // Logs: Defines the logs used by this service.
3900 Logs []*LogDescriptor `json:"logs,omitempty"`
3901 // Metrics: Defines the metrics used by this service.
3902 Metrics []*MetricDescriptor `json:"metrics,omitempty"`
3903 // MonitoredResources: Defines the monitored resources used by this service.
3904 // This is required by the `Service.monitoring` and `Service.logging`
3905 // configurations.
3906 MonitoredResources []*MonitoredResourceDescriptor `json:"monitoredResources,omitempty"`
3907 // Monitoring: Monitoring configuration.
3908 Monitoring *Monitoring `json:"monitoring,omitempty"`
3909 // Name: The service name, which is a DNS-like logical identifier for the
3910 // service, such as `calendar.googleapis.com`. The service name typically goes
3911 // through DNS verification to make sure the owner of the service also owns the
3912 // DNS name.
3913 Name string `json:"name,omitempty"`
3914 // ProducerProjectId: The Google project that owns this service.
3915 ProducerProjectId string `json:"producerProjectId,omitempty"`
3916 // Publishing: Settings for Google Cloud Client libraries
3917 // (https://cloud.google.com/apis/docs/cloud-client-libraries) generated from
3918 // APIs defined as protocol buffers.
3919 Publishing *Publishing `json:"publishing,omitempty"`
3920 // Quota: Quota configuration.
3921 Quota *Quota `json:"quota,omitempty"`
3922 // SourceInfo: Output only. The source information for this configuration if
3923 // available.
3924 SourceInfo *SourceInfo `json:"sourceInfo,omitempty"`
3925 // SystemParameters: System parameter configuration.
3926 SystemParameters *SystemParameters `json:"systemParameters,omitempty"`
3927 // SystemTypes: A list of all proto message types included in this API service.
3928 // It serves similar purpose as [google.api.Service.types], except that these
3929 // types are not needed by user-defined APIs. Therefore, they will not show up
3930 // in the generated discovery doc. This field should only be used to define
3931 // system APIs in ESF.
3932 SystemTypes []*Type `json:"systemTypes,omitempty"`
3933 // Title: The product title for this service, it is the name displayed in
3934 // Google Cloud Console.
3935 Title string `json:"title,omitempty"`
3936 // Types: A list of all proto message types included in this API service. Types
3937 // referenced directly or indirectly by the `apis` are automatically included.
3938 // Messages which are not referenced but shall be included, such as types used
3939 // by the `google.protobuf.Any` type, should be listed here by name by the
3940 // configuration author. Example: types: - name: google.protobuf.Int32
3941 Types []*Type `json:"types,omitempty"`
3942 // Usage: Configuration controlling usage of this service.
3943 Usage *Usage `json:"usage,omitempty"`
3944 // ForceSendFields is a list of field names (e.g. "Apis") to unconditionally
3945 // include in API requests. By default, fields with empty or default values are
3946 // omitted from API requests. See
3947 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3948 // details.
3949 ForceSendFields []string `json:"-"`
3950 // NullFields is a list of field names (e.g. "Apis") to include in API requests
3951 // with the JSON null value. By default, fields with empty values are omitted
3952 // from API requests. See
3953 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3954 NullFields []string `json:"-"`
3955 }
3956
3957 func (s Service) MarshalJSON() ([]byte, error) {
3958 type NoMethod Service
3959 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3960 }
3961
3962 // SourceContext: `SourceContext` represents information about the source of a
3963 // protobuf element, like the file in which it is defined.
3964 type SourceContext struct {
3965 // FileName: The path-qualified name of the .proto file that contained the
3966 // associated protobuf element. For example:
3967 // "google/protobuf/source_context.proto".
3968 FileName string `json:"fileName,omitempty"`
3969 // ForceSendFields is a list of field names (e.g. "FileName") to
3970 // unconditionally include in API requests. By default, fields with empty or
3971 // default values are omitted from API requests. See
3972 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3973 // details.
3974 ForceSendFields []string `json:"-"`
3975 // NullFields is a list of field names (e.g. "FileName") to include in API
3976 // requests with the JSON null value. By default, fields with empty values are
3977 // omitted from API requests. See
3978 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
3979 NullFields []string `json:"-"`
3980 }
3981
3982 func (s SourceContext) MarshalJSON() ([]byte, error) {
3983 type NoMethod SourceContext
3984 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
3985 }
3986
3987 // SourceInfo: Source information used to create a Service Config
3988 type SourceInfo struct {
3989 // SourceFiles: All files used during config generation.
3990 SourceFiles []googleapi.RawMessage `json:"sourceFiles,omitempty"`
3991 // ForceSendFields is a list of field names (e.g. "SourceFiles") to
3992 // unconditionally include in API requests. By default, fields with empty or
3993 // default values are omitted from API requests. See
3994 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
3995 // details.
3996 ForceSendFields []string `json:"-"`
3997 // NullFields is a list of field names (e.g. "SourceFiles") to include in API
3998 // requests with the JSON null value. By default, fields with empty values are
3999 // omitted from API requests. See
4000 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
4001 NullFields []string `json:"-"`
4002 }
4003
4004 func (s SourceInfo) MarshalJSON() ([]byte, error) {
4005 type NoMethod SourceInfo
4006 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
4007 }
4008
4009 // Status: The `Status` type defines a logical error model that is suitable for
4010 // different programming environments, including REST APIs and RPC APIs. It is
4011 // used by gRPC (https://github.com/grpc). Each `Status` message contains three
4012 // pieces of data: error code, error message, and error details. You can find
4013 // out more about this error model and how to work with it in the API Design
4014 // Guide (https://cloud.google.com/apis/design/errors).
4015 type Status struct {
4016 // Code: The status code, which should be an enum value of google.rpc.Code.
4017 Code int64 `json:"code,omitempty"`
4018 // Details: A list of messages that carry the error details. There is a common
4019 // set of message types for APIs to use.
4020 Details []googleapi.RawMessage `json:"details,omitempty"`
4021 // Message: A developer-facing error message, which should be in English. Any
4022 // user-facing error message should be localized and sent in the
4023 // google.rpc.Status.details field, or localized by the client.
4024 Message string `json:"message,omitempty"`
4025 // ForceSendFields is a list of field names (e.g. "Code") to unconditionally
4026 // include in API requests. By default, fields with empty or default values are
4027 // omitted from API requests. See
4028 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
4029 // details.
4030 ForceSendFields []string `json:"-"`
4031 // NullFields is a list of field names (e.g. "Code") to include in API requests
4032 // with the JSON null value. By default, fields with empty values are omitted
4033 // from API requests. See
4034 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
4035 NullFields []string `json:"-"`
4036 }
4037
4038 func (s Status) MarshalJSON() ([]byte, error) {
4039 type NoMethod Status
4040 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
4041 }
4042
4043 // Subnetwork: Represents a subnet that was created or discovered by a private
4044 // access management service.
4045 type Subnetwork struct {
4046 // IpCidrRange: Subnetwork CIDR range in `10.x.x.x/y` format.
4047 IpCidrRange string `json:"ipCidrRange,omitempty"`
4048 // Name: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/
4049 Name string `json:"name,omitempty"`
4050 // Network: In the Shared VPC host project, the VPC network that's peered with
4051 // the consumer network. For example:
4052 // `projects/1234321/global/networks/host-network`
4053 Network string `json:"network,omitempty"`
4054 // OutsideAllocation: This is a discovered subnet that is not within the
4055 // current consumer allocated ranges.
4056 OutsideAllocation bool `json:"outsideAllocation,omitempty"`
4057 // Region: GCP region where the subnetwork is located.
4058 Region string `json:"region,omitempty"`
4059 // SecondaryIpRanges: List of secondary IP ranges in this subnetwork.
4060 SecondaryIpRanges []*SecondaryIpRange `json:"secondaryIpRanges,omitempty"`
4061 // ForceSendFields is a list of field names (e.g. "IpCidrRange") to
4062 // unconditionally include in API requests. By default, fields with empty or
4063 // default values are omitted from API requests. See
4064 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
4065 // details.
4066 ForceSendFields []string `json:"-"`
4067 // NullFields is a list of field names (e.g. "IpCidrRange") to include in API
4068 // requests with the JSON null value. By default, fields with empty values are
4069 // omitted from API requests. See
4070 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
4071 NullFields []string `json:"-"`
4072 }
4073
4074 func (s Subnetwork) MarshalJSON() ([]byte, error) {
4075 type NoMethod Subnetwork
4076 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
4077 }
4078
4079 // SystemParameter: Define a parameter's name and location. The parameter may
4080 // be passed as either an HTTP header or a URL query parameter, and if both are
4081 // passed the behavior is implementation-dependent.
4082 type SystemParameter struct {
4083 // HttpHeader: Define the HTTP header name to use for the parameter. It is case
4084 // insensitive.
4085 HttpHeader string `json:"httpHeader,omitempty"`
4086 // Name: Define the name of the parameter, such as "api_key" . It is case
4087 // sensitive.
4088 Name string `json:"name,omitempty"`
4089 // UrlQueryParameter: Define the URL query parameter name to use for the
4090 // parameter. It is case sensitive.
4091 UrlQueryParameter string `json:"urlQueryParameter,omitempty"`
4092 // ForceSendFields is a list of field names (e.g. "HttpHeader") to
4093 // unconditionally include in API requests. By default, fields with empty or
4094 // default values are omitted from API requests. See
4095 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
4096 // details.
4097 ForceSendFields []string `json:"-"`
4098 // NullFields is a list of field names (e.g. "HttpHeader") to include in API
4099 // requests with the JSON null value. By default, fields with empty values are
4100 // omitted from API requests. See
4101 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
4102 NullFields []string `json:"-"`
4103 }
4104
4105 func (s SystemParameter) MarshalJSON() ([]byte, error) {
4106 type NoMethod SystemParameter
4107 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
4108 }
4109
4110 // SystemParameterRule: Define a system parameter rule mapping system parameter
4111 // definitions to methods.
4112 type SystemParameterRule struct {
4113 // Parameters: Define parameters. Multiple names may be defined for a
4114 // parameter. For a given method call, only one of them should be used. If
4115 // multiple names are used the behavior is implementation-dependent. If none of
4116 // the specified names are present the behavior is parameter-dependent.
4117 Parameters []*SystemParameter `json:"parameters,omitempty"`
4118 // Selector: Selects the methods to which this rule applies. Use '*' to
4119 // indicate all methods in all APIs. Refer to selector for syntax details.
4120 Selector string `json:"selector,omitempty"`
4121 // ForceSendFields is a list of field names (e.g. "Parameters") to
4122 // unconditionally include in API requests. By default, fields with empty or
4123 // default values are omitted from API requests. See
4124 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
4125 // details.
4126 ForceSendFields []string `json:"-"`
4127 // NullFields is a list of field names (e.g. "Parameters") to include in API
4128 // requests with the JSON null value. By default, fields with empty values are
4129 // omitted from API requests. See
4130 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
4131 NullFields []string `json:"-"`
4132 }
4133
4134 func (s SystemParameterRule) MarshalJSON() ([]byte, error) {
4135 type NoMethod SystemParameterRule
4136 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
4137 }
4138
4139 // SystemParameters: ### System parameter configuration A system parameter is a
4140 // special kind of parameter defined by the API system, not by an individual
4141 // API. It is typically mapped to an HTTP header and/or a URL query parameter.
4142 // This configuration specifies which methods change the names of the system
4143 // parameters.
4144 type SystemParameters struct {
4145 // Rules: Define system parameters. The parameters defined here will override
4146 // the default parameters implemented by the system. If this field is missing
4147 // from the service config, default system parameters will be used. Default
4148 // system parameters and names is implementation-dependent. Example: define api
4149 // key for all methods system_parameters rules: - selector: "*" parameters: -
4150 // name: api_key url_query_parameter: api_key Example: define 2 api key names
4151 // for a specific method. system_parameters rules: - selector: "/ListShelves"
4152 // parameters: - name: api_key http_header: Api-Key1 - name: api_key
4153 // http_header: Api-Key2 **NOTE:** All service configuration rules follow "last
4154 // one wins" order.
4155 Rules []*SystemParameterRule `json:"rules,omitempty"`
4156 // ForceSendFields is a list of field names (e.g. "Rules") to unconditionally
4157 // include in API requests. By default, fields with empty or default values are
4158 // omitted from API requests. See
4159 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
4160 // details.
4161 ForceSendFields []string `json:"-"`
4162 // NullFields is a list of field names (e.g. "Rules") to include in API
4163 // requests with the JSON null value. By default, fields with empty values are
4164 // omitted from API requests. See
4165 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
4166 NullFields []string `json:"-"`
4167 }
4168
4169 func (s SystemParameters) MarshalJSON() ([]byte, error) {
4170 type NoMethod SystemParameters
4171 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
4172 }
4173
4174 // Type: A protocol buffer message type. New usages of this message as an
4175 // alternative to DescriptorProto are strongly discouraged. This message does
4176 // not reliability preserve all information necessary to model the schema and
4177 // preserve semantics. Instead make use of FileDescriptorSet which preserves
4178 // the necessary information.
4179 type Type struct {
4180 // Edition: The source edition string, only valid when syntax is
4181 // SYNTAX_EDITIONS.
4182 Edition string `json:"edition,omitempty"`
4183 // Fields: The list of fields.
4184 Fields []*Field `json:"fields,omitempty"`
4185 // Name: The fully qualified message name.
4186 Name string `json:"name,omitempty"`
4187 // Oneofs: The list of types appearing in `oneof` definitions in this type.
4188 Oneofs []string `json:"oneofs,omitempty"`
4189 // Options: The protocol buffer options.
4190 Options []*Option `json:"options,omitempty"`
4191 // SourceContext: The source context.
4192 SourceContext *SourceContext `json:"sourceContext,omitempty"`
4193 // Syntax: The source syntax.
4194 //
4195 // Possible values:
4196 // "SYNTAX_PROTO2" - Syntax `proto2`.
4197 // "SYNTAX_PROTO3" - Syntax `proto3`.
4198 // "SYNTAX_EDITIONS" - Syntax `editions`.
4199 Syntax string `json:"syntax,omitempty"`
4200 // ForceSendFields is a list of field names (e.g. "Edition") to unconditionally
4201 // include in API requests. By default, fields with empty or default values are
4202 // omitted from API requests. See
4203 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
4204 // details.
4205 ForceSendFields []string `json:"-"`
4206 // NullFields is a list of field names (e.g. "Edition") to include in API
4207 // requests with the JSON null value. By default, fields with empty values are
4208 // omitted from API requests. See
4209 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
4210 NullFields []string `json:"-"`
4211 }
4212
4213 func (s Type) MarshalJSON() ([]byte, error) {
4214 type NoMethod Type
4215 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
4216 }
4217
4218 // UpdateDnsRecordSetMetadata: Metadata provided through GetOperation request
4219 // for the LRO generated by UpdateDnsRecordSet API
4220 type UpdateDnsRecordSetMetadata struct {
4221 }
4222
4223 // Usage: Configuration controlling usage of a service.
4224 type Usage struct {
4225 // ProducerNotificationChannel: The full resource name of a channel used for
4226 // sending notifications to the service producer. Google Service Management
4227 // currently only supports Google Cloud Pub/Sub
4228 // (https://cloud.google.com/pubsub) as a notification channel. To use Google
4229 // Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic
4230 // that uses the Cloud Pub/Sub topic name format documented in
4231 // https://cloud.google.com/pubsub/docs/overview.
4232 ProducerNotificationChannel string `json:"producerNotificationChannel,omitempty"`
4233 // Requirements: Requirements that must be satisfied before a consumer project
4234 // can use the service. Each requirement is of the form /; for example
4235 // 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of
4236 // Service requirement must be included here. Google Cloud APIs must include
4237 // "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include
4238 // "serviceusage.googleapis.com/tos/universal". Additional ToS can be included
4239 // based on the business needs.
4240 Requirements []string `json:"requirements,omitempty"`
4241 // Rules: A list of usage rules that apply to individual API methods. **NOTE:**
4242 // All service configuration rules follow "last one wins" order.
4243 Rules []*UsageRule `json:"rules,omitempty"`
4244 // ForceSendFields is a list of field names (e.g.
4245 // "ProducerNotificationChannel") to unconditionally include in API requests.
4246 // By default, fields with empty or default values are omitted from API
4247 // requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
4248 // for more details.
4249 ForceSendFields []string `json:"-"`
4250 // NullFields is a list of field names (e.g. "ProducerNotificationChannel") to
4251 // include in API requests with the JSON null value. By default, fields with
4252 // empty values are omitted from API requests. See
4253 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
4254 NullFields []string `json:"-"`
4255 }
4256
4257 func (s Usage) MarshalJSON() ([]byte, error) {
4258 type NoMethod Usage
4259 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
4260 }
4261
4262 // UsageRule: Usage configuration rules for the service.
4263 type UsageRule struct {
4264 // AllowUnregisteredCalls: Use this rule to configure unregistered calls for
4265 // the service. Unregistered calls are calls that do not contain consumer
4266 // project identity. (Example: calls that do not contain an API key). WARNING:
4267 // By default, API methods do not allow unregistered calls, and each method
4268 // call must be identified by a consumer project identity.
4269 AllowUnregisteredCalls bool `json:"allowUnregisteredCalls,omitempty"`
4270 // Selector: Selects the methods to which this rule applies. Use '*' to
4271 // indicate all methods in all APIs. Refer to selector for syntax details.
4272 Selector string `json:"selector,omitempty"`
4273 // SkipServiceControl: If true, the selected method should skip service control
4274 // and the control plane features, such as quota and billing, will not be
4275 // available. This flag is used by Google Cloud Endpoints to bypass checks for
4276 // internal methods, such as service health check methods.
4277 SkipServiceControl bool `json:"skipServiceControl,omitempty"`
4278 // ForceSendFields is a list of field names (e.g. "AllowUnregisteredCalls") to
4279 // unconditionally include in API requests. By default, fields with empty or
4280 // default values are omitted from API requests. See
4281 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
4282 // details.
4283 ForceSendFields []string `json:"-"`
4284 // NullFields is a list of field names (e.g. "AllowUnregisteredCalls") to
4285 // include in API requests with the JSON null value. By default, fields with
4286 // empty values are omitted from API requests. See
4287 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
4288 NullFields []string `json:"-"`
4289 }
4290
4291 func (s UsageRule) MarshalJSON() ([]byte, error) {
4292 type NoMethod UsageRule
4293 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
4294 }
4295
4296 // VpcServiceControls: Response for the get VPC Service Controls request.
4297 type VpcServiceControls struct {
4298 // Enabled: Output only. Indicates whether the VPC Service Controls are enabled
4299 // or disabled for the connection. If the consumer called the
4300 // EnableVpcServiceControls method, then this is true. If the consumer called
4301 // DisableVpcServiceControls, then this is false. The default is false.
4302 Enabled bool `json:"enabled,omitempty"`
4303 // ForceSendFields is a list of field names (e.g. "Enabled") to unconditionally
4304 // include in API requests. By default, fields with empty or default values are
4305 // omitted from API requests. See
4306 // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
4307 // details.
4308 ForceSendFields []string `json:"-"`
4309 // NullFields is a list of field names (e.g. "Enabled") to include in API
4310 // requests with the JSON null value. By default, fields with empty values are
4311 // omitted from API requests. See
4312 // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
4313 NullFields []string `json:"-"`
4314 }
4315
4316 func (s VpcServiceControls) MarshalJSON() ([]byte, error) {
4317 type NoMethod VpcServiceControls
4318 return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
4319 }
4320
4321 type OperationsGetCall struct {
4322 s *APIService
4323 name string
4324 urlParams_ gensupport.URLParams
4325 ifNoneMatch_ string
4326 ctx_ context.Context
4327 header_ http.Header
4328 }
4329
4330 // Get: Gets the latest state of a long-running operation. Clients can use this
4331 // method to poll the operation result at intervals as recommended by the API
4332 // service.
4333 //
4334 // - name: The name of the operation resource.
4335 func (r *OperationsService) Get(name string) *OperationsGetCall {
4336 c := &OperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
4337 c.name = name
4338 return c
4339 }
4340
4341 // Fields allows partial responses to be retrieved. See
4342 // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
4343 // details.
4344 func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall {
4345 c.urlParams_.Set("fields", googleapi.CombineFields(s))
4346 return c
4347 }
4348
4349 // IfNoneMatch sets an optional parameter which makes the operation fail if the
4350 // object's ETag matches the given value. This is useful for getting updates
4351 // only after the object has changed since the last request.
4352 func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall {
4353 c.ifNoneMatch_ = entityTag
4354 return c
4355 }
4356
4357 // Context sets the context to be used in this call's Do method.
4358 func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall {
4359 c.ctx_ = ctx
4360 return c
4361 }
4362
4363 // Header returns a http.Header that can be modified by the caller to add
4364 // headers to the request.
4365 func (c *OperationsGetCall) Header() http.Header {
4366 if c.header_ == nil {
4367 c.header_ = make(http.Header)
4368 }
4369 return c.header_
4370 }
4371
4372 func (c *OperationsGetCall) doRequest(alt string) (*http.Response, error) {
4373 reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_)
4374 if c.ifNoneMatch_ != "" {
4375 reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
4376 }
4377 c.urlParams_.Set("alt", alt)
4378 c.urlParams_.Set("prettyPrint", "false")
4379 urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+name}")
4380 urls += "?" + c.urlParams_.Encode()
4381 req, err := http.NewRequest("GET", urls, nil)
4382 if err != nil {
4383 return nil, err
4384 }
4385 req.Header = reqHeaders
4386 googleapi.Expand(req.URL, map[string]string{
4387 "name": c.name,
4388 })
4389 c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "servicenetworking.operations.get", "request", internallog.HTTPRequest(req, nil))
4390 return gensupport.SendRequest(c.ctx_, c.s.client, req)
4391 }
4392
4393 // Do executes the "servicenetworking.operations.get" call.
4394 // Any non-2xx status code is an error. Response headers are in either
4395 // *Operation.ServerResponse.Header or (if a response was returned at all) in
4396 // error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
4397 // whether the returned error was because http.StatusNotModified was returned.
4398 func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
4399 gensupport.SetOptions(c.urlParams_, opts...)
4400 res, err := c.doRequest("json")
4401 if res != nil && res.StatusCode == http.StatusNotModified {
4402 if res.Body != nil {
4403 res.Body.Close()
4404 }
4405 return nil, gensupport.WrapError(&googleapi.Error{
4406 Code: res.StatusCode,
4407 Header: res.Header,
4408 })
4409 }
4410 if err != nil {
4411 return nil, err
4412 }
4413 defer googleapi.CloseBody(res)
4414 if err := googleapi.CheckResponse(res); err != nil {
4415 return nil, gensupport.WrapError(err)
4416 }
4417 ret := &Operation{
4418 ServerResponse: googleapi.ServerResponse{
4419 Header: res.Header,
4420 HTTPStatusCode: res.StatusCode,
4421 },
4422 }
4423 target := &ret
4424 b, err := gensupport.DecodeResponseBytes(target, res)
4425 if err != nil {
4426 return nil, err
4427 }
4428 c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "servicenetworking.operations.get", "response", internallog.HTTPResponse(res, b))
4429 return ret, nil
4430 }
4431
4432 type ServicesAddSubnetworkCall struct {
4433 s *APIService
4434 parent string
4435 addsubnetworkrequest *AddSubnetworkRequest
4436 urlParams_ gensupport.URLParams
4437 ctx_ context.Context
4438 header_ http.Header
4439 }
4440
4441 // AddSubnetwork: For service producers, provisions a new subnet in a peered
4442 // service's shared VPC network in the requested region and with the requested
4443 // size that's expressed as a CIDR range (number of leading bits of ipV4
4444 // network mask). The method checks against the assigned allocated ranges to
4445 // find a non-conflicting IP address range. The method will reuse a subnet if
4446 // subsequent calls contain the same subnet name, region, and prefix length.
4447 // This method will make producer's tenant project to be a shared VPC service
4448 // project as needed. The response from the `get` operation will be of type
4449 // `Subnetwork` if the operation successfully completes.
4450 //
4451 // - parent: A tenant project in the service producer organization, in the
4452 // following format: services/{service}/{collection-id}/{resource-id}.
4453 // {collection-id} is the cloud resource collection type that represents the
4454 // tenant project. Only `projects` are supported. {resource-id} is the tenant
4455 // project numeric id, such as `123456`. {service} the name of the peering
4456 // service, such as `service-peering.example.com`. This service must already
4457 // be enabled in the service consumer's project.
4458 func (r *ServicesService) AddSubnetwork(parent string, addsubnetworkrequest *AddSubnetworkRequest) *ServicesAddSubnetworkCall {
4459 c := &ServicesAddSubnetworkCall{s: r.s, urlParams_: make(gensupport.URLParams)}
4460 c.parent = parent
4461 c.addsubnetworkrequest = addsubnetworkrequest
4462 return c
4463 }
4464
4465 // Fields allows partial responses to be retrieved. See
4466 // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
4467 // details.
4468 func (c *ServicesAddSubnetworkCall) Fields(s ...googleapi.Field) *ServicesAddSubnetworkCall {
4469 c.urlParams_.Set("fields", googleapi.CombineFields(s))
4470 return c
4471 }
4472
4473 // Context sets the context to be used in this call's Do method.
4474 func (c *ServicesAddSubnetworkCall) Context(ctx context.Context) *ServicesAddSubnetworkCall {
4475 c.ctx_ = ctx
4476 return c
4477 }
4478
4479 // Header returns a http.Header that can be modified by the caller to add
4480 // headers to the request.
4481 func (c *ServicesAddSubnetworkCall) Header() http.Header {
4482 if c.header_ == nil {
4483 c.header_ = make(http.Header)
4484 }
4485 return c.header_
4486 }
4487
4488 func (c *ServicesAddSubnetworkCall) doRequest(alt string) (*http.Response, error) {
4489 reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_)
4490 body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.addsubnetworkrequest)
4491 if err != nil {
4492 return nil, err
4493 }
4494 c.urlParams_.Set("alt", alt)
4495 c.urlParams_.Set("prettyPrint", "false")
4496 urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+parent}:addSubnetwork")
4497 urls += "?" + c.urlParams_.Encode()
4498 req, err := http.NewRequest("POST", urls, body)
4499 if err != nil {
4500 return nil, err
4501 }
4502 req.Header = reqHeaders
4503 googleapi.Expand(req.URL, map[string]string{
4504 "parent": c.parent,
4505 })
4506 c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "servicenetworking.services.addSubnetwork", "request", internallog.HTTPRequest(req, body.Bytes()))
4507 return gensupport.SendRequest(c.ctx_, c.s.client, req)
4508 }
4509
4510 // Do executes the "servicenetworking.services.addSubnetwork" call.
4511 // Any non-2xx status code is an error. Response headers are in either
4512 // *Operation.ServerResponse.Header or (if a response was returned at all) in
4513 // error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
4514 // whether the returned error was because http.StatusNotModified was returned.
4515 func (c *ServicesAddSubnetworkCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
4516 gensupport.SetOptions(c.urlParams_, opts...)
4517 res, err := c.doRequest("json")
4518 if res != nil && res.StatusCode == http.StatusNotModified {
4519 if res.Body != nil {
4520 res.Body.Close()
4521 }
4522 return nil, gensupport.WrapError(&googleapi.Error{
4523 Code: res.StatusCode,
4524 Header: res.Header,
4525 })
4526 }
4527 if err != nil {
4528 return nil, err
4529 }
4530 defer googleapi.CloseBody(res)
4531 if err := googleapi.CheckResponse(res); err != nil {
4532 return nil, gensupport.WrapError(err)
4533 }
4534 ret := &Operation{
4535 ServerResponse: googleapi.ServerResponse{
4536 Header: res.Header,
4537 HTTPStatusCode: res.StatusCode,
4538 },
4539 }
4540 target := &ret
4541 b, err := gensupport.DecodeResponseBytes(target, res)
4542 if err != nil {
4543 return nil, err
4544 }
4545 c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "servicenetworking.services.addSubnetwork", "response", internallog.HTTPResponse(res, b))
4546 return ret, nil
4547 }
4548
4549 type ServicesSearchRangeCall struct {
4550 s *APIService
4551 parent string
4552 searchrangerequest *SearchRangeRequest
4553 urlParams_ gensupport.URLParams
4554 ctx_ context.Context
4555 header_ http.Header
4556 }
4557
4558 // SearchRange: Service producers can use this method to find a currently
4559 // unused range within consumer allocated ranges. This returned range is not
4560 // reserved, and not guaranteed to remain unused. It will validate previously
4561 // provided allocated ranges, find non-conflicting sub-range of requested size
4562 // (expressed in number of leading bits of ipv4 network mask, as in CIDR range
4563 // notation). Operation
4564 //
4565 // - parent: This is in a form services/{service}. {service} the name of the
4566 // private access management service, for example
4567 // 'service-peering.example.com'.
4568 func (r *ServicesService) SearchRange(parent string, searchrangerequest *SearchRangeRequest) *ServicesSearchRangeCall {
4569 c := &ServicesSearchRangeCall{s: r.s, urlParams_: make(gensupport.URLParams)}
4570 c.parent = parent
4571 c.searchrangerequest = searchrangerequest
4572 return c
4573 }
4574
4575 // Fields allows partial responses to be retrieved. See
4576 // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
4577 // details.
4578 func (c *ServicesSearchRangeCall) Fields(s ...googleapi.Field) *ServicesSearchRangeCall {
4579 c.urlParams_.Set("fields", googleapi.CombineFields(s))
4580 return c
4581 }
4582
4583 // Context sets the context to be used in this call's Do method.
4584 func (c *ServicesSearchRangeCall) Context(ctx context.Context) *ServicesSearchRangeCall {
4585 c.ctx_ = ctx
4586 return c
4587 }
4588
4589 // Header returns a http.Header that can be modified by the caller to add
4590 // headers to the request.
4591 func (c *ServicesSearchRangeCall) Header() http.Header {
4592 if c.header_ == nil {
4593 c.header_ = make(http.Header)
4594 }
4595 return c.header_
4596 }
4597
4598 func (c *ServicesSearchRangeCall) doRequest(alt string) (*http.Response, error) {
4599 reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_)
4600 body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.searchrangerequest)
4601 if err != nil {
4602 return nil, err
4603 }
4604 c.urlParams_.Set("alt", alt)
4605 c.urlParams_.Set("prettyPrint", "false")
4606 urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+parent}:searchRange")
4607 urls += "?" + c.urlParams_.Encode()
4608 req, err := http.NewRequest("POST", urls, body)
4609 if err != nil {
4610 return nil, err
4611 }
4612 req.Header = reqHeaders
4613 googleapi.Expand(req.URL, map[string]string{
4614 "parent": c.parent,
4615 })
4616 c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "servicenetworking.services.searchRange", "request", internallog.HTTPRequest(req, body.Bytes()))
4617 return gensupport.SendRequest(c.ctx_, c.s.client, req)
4618 }
4619
4620 // Do executes the "servicenetworking.services.searchRange" call.
4621 // Any non-2xx status code is an error. Response headers are in either
4622 // *Operation.ServerResponse.Header or (if a response was returned at all) in
4623 // error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
4624 // whether the returned error was because http.StatusNotModified was returned.
4625 func (c *ServicesSearchRangeCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
4626 gensupport.SetOptions(c.urlParams_, opts...)
4627 res, err := c.doRequest("json")
4628 if res != nil && res.StatusCode == http.StatusNotModified {
4629 if res.Body != nil {
4630 res.Body.Close()
4631 }
4632 return nil, gensupport.WrapError(&googleapi.Error{
4633 Code: res.StatusCode,
4634 Header: res.Header,
4635 })
4636 }
4637 if err != nil {
4638 return nil, err
4639 }
4640 defer googleapi.CloseBody(res)
4641 if err := googleapi.CheckResponse(res); err != nil {
4642 return nil, gensupport.WrapError(err)
4643 }
4644 ret := &Operation{
4645 ServerResponse: googleapi.ServerResponse{
4646 Header: res.Header,
4647 HTTPStatusCode: res.StatusCode,
4648 },
4649 }
4650 target := &ret
4651 b, err := gensupport.DecodeResponseBytes(target, res)
4652 if err != nil {
4653 return nil, err
4654 }
4655 c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "servicenetworking.services.searchRange", "response", internallog.HTTPResponse(res, b))
4656 return ret, nil
4657 }
4658
4659 type ServicesUpdateConnectionsCall struct {
4660 s *APIService
4661 name string
4662 googlecloudservicenetworkingv1betaconnection *GoogleCloudServicenetworkingV1betaConnection
4663 urlParams_ gensupport.URLParams
4664 ctx_ context.Context
4665 header_ http.Header
4666 }
4667
4668 // UpdateConnections: Updates the allocated ranges that are assigned to a
4669 // connection. The response from the `get` operation will be of type
4670 // `Connection` if the operation successfully completes.
4671 //
4672 // - name: The service producer peering service that is managing peering
4673 // connectivity for a service producer organization. For Google services that
4674 // support this functionality, this is
4675 // `services/servicenetworking.googleapis.com`.
4676 func (r *ServicesService) UpdateConnections(name string, googlecloudservicenetworkingv1betaconnection *GoogleCloudServicenetworkingV1betaConnection) *ServicesUpdateConnectionsCall {
4677 c := &ServicesUpdateConnectionsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
4678 c.name = name
4679 c.googlecloudservicenetworkingv1betaconnection = googlecloudservicenetworkingv1betaconnection
4680 return c
4681 }
4682
4683 // Force sets the optional parameter "force": If a previously defined allocated
4684 // range is removed, force flag must be set to true.
4685 func (c *ServicesUpdateConnectionsCall) Force(force bool) *ServicesUpdateConnectionsCall {
4686 c.urlParams_.Set("force", fmt.Sprint(force))
4687 return c
4688 }
4689
4690 // UpdateMask sets the optional parameter "updateMask": The update mask. If
4691 // this is omitted, it defaults to "*". You can only update the listed peering
4692 // ranges.
4693 func (c *ServicesUpdateConnectionsCall) UpdateMask(updateMask string) *ServicesUpdateConnectionsCall {
4694 c.urlParams_.Set("updateMask", updateMask)
4695 return c
4696 }
4697
4698 // Fields allows partial responses to be retrieved. See
4699 // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
4700 // details.
4701 func (c *ServicesUpdateConnectionsCall) Fields(s ...googleapi.Field) *ServicesUpdateConnectionsCall {
4702 c.urlParams_.Set("fields", googleapi.CombineFields(s))
4703 return c
4704 }
4705
4706 // Context sets the context to be used in this call's Do method.
4707 func (c *ServicesUpdateConnectionsCall) Context(ctx context.Context) *ServicesUpdateConnectionsCall {
4708 c.ctx_ = ctx
4709 return c
4710 }
4711
4712 // Header returns a http.Header that can be modified by the caller to add
4713 // headers to the request.
4714 func (c *ServicesUpdateConnectionsCall) Header() http.Header {
4715 if c.header_ == nil {
4716 c.header_ = make(http.Header)
4717 }
4718 return c.header_
4719 }
4720
4721 func (c *ServicesUpdateConnectionsCall) doRequest(alt string) (*http.Response, error) {
4722 reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_)
4723 body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.googlecloudservicenetworkingv1betaconnection)
4724 if err != nil {
4725 return nil, err
4726 }
4727 c.urlParams_.Set("alt", alt)
4728 c.urlParams_.Set("prettyPrint", "false")
4729 urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+name}/connections")
4730 urls += "?" + c.urlParams_.Encode()
4731 req, err := http.NewRequest("PATCH", urls, body)
4732 if err != nil {
4733 return nil, err
4734 }
4735 req.Header = reqHeaders
4736 googleapi.Expand(req.URL, map[string]string{
4737 "name": c.name,
4738 })
4739 c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "servicenetworking.services.updateConnections", "request", internallog.HTTPRequest(req, body.Bytes()))
4740 return gensupport.SendRequest(c.ctx_, c.s.client, req)
4741 }
4742
4743 // Do executes the "servicenetworking.services.updateConnections" call.
4744 // Any non-2xx status code is an error. Response headers are in either
4745 // *Operation.ServerResponse.Header or (if a response was returned at all) in
4746 // error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
4747 // whether the returned error was because http.StatusNotModified was returned.
4748 func (c *ServicesUpdateConnectionsCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
4749 gensupport.SetOptions(c.urlParams_, opts...)
4750 res, err := c.doRequest("json")
4751 if res != nil && res.StatusCode == http.StatusNotModified {
4752 if res.Body != nil {
4753 res.Body.Close()
4754 }
4755 return nil, gensupport.WrapError(&googleapi.Error{
4756 Code: res.StatusCode,
4757 Header: res.Header,
4758 })
4759 }
4760 if err != nil {
4761 return nil, err
4762 }
4763 defer googleapi.CloseBody(res)
4764 if err := googleapi.CheckResponse(res); err != nil {
4765 return nil, gensupport.WrapError(err)
4766 }
4767 ret := &Operation{
4768 ServerResponse: googleapi.ServerResponse{
4769 Header: res.Header,
4770 HTTPStatusCode: res.StatusCode,
4771 },
4772 }
4773 target := &ret
4774 b, err := gensupport.DecodeResponseBytes(target, res)
4775 if err != nil {
4776 return nil, err
4777 }
4778 c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "servicenetworking.services.updateConnections", "response", internallog.HTTPResponse(res, b))
4779 return ret, nil
4780 }
4781
4782 type ServicesConnectionsCreateCall struct {
4783 s *APIService
4784 parent string
4785 googlecloudservicenetworkingv1betaconnection *GoogleCloudServicenetworkingV1betaConnection
4786 urlParams_ gensupport.URLParams
4787 ctx_ context.Context
4788 header_ http.Header
4789 }
4790
4791 // Create: Creates a private connection that establishes a VPC Network Peering
4792 // connection to a VPC network in the service producer's organization. The
4793 // administrator of the service consumer's VPC network invokes this method. The
4794 // administrator must assign one or more allocated IP ranges for provisioning
4795 // subnetworks in the service producer's VPC network. This connection is used
4796 // for all supported services in the service producer's organization, so it
4797 // only needs to be invoked once. The response from the `get` operation will be
4798 // of type `Connection` if the operation successfully completes.
4799 //
4800 // - parent: The service that is managing peering connectivity for a service
4801 // producer's organization. For Google services that support this
4802 // functionality, this value is `services/servicenetworking.googleapis.com`.
4803 func (r *ServicesConnectionsService) Create(parent string, googlecloudservicenetworkingv1betaconnection *GoogleCloudServicenetworkingV1betaConnection) *ServicesConnectionsCreateCall {
4804 c := &ServicesConnectionsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
4805 c.parent = parent
4806 c.googlecloudservicenetworkingv1betaconnection = googlecloudservicenetworkingv1betaconnection
4807 return c
4808 }
4809
4810 // Fields allows partial responses to be retrieved. See
4811 // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
4812 // details.
4813 func (c *ServicesConnectionsCreateCall) Fields(s ...googleapi.Field) *ServicesConnectionsCreateCall {
4814 c.urlParams_.Set("fields", googleapi.CombineFields(s))
4815 return c
4816 }
4817
4818 // Context sets the context to be used in this call's Do method.
4819 func (c *ServicesConnectionsCreateCall) Context(ctx context.Context) *ServicesConnectionsCreateCall {
4820 c.ctx_ = ctx
4821 return c
4822 }
4823
4824 // Header returns a http.Header that can be modified by the caller to add
4825 // headers to the request.
4826 func (c *ServicesConnectionsCreateCall) Header() http.Header {
4827 if c.header_ == nil {
4828 c.header_ = make(http.Header)
4829 }
4830 return c.header_
4831 }
4832
4833 func (c *ServicesConnectionsCreateCall) doRequest(alt string) (*http.Response, error) {
4834 reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_)
4835 body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.googlecloudservicenetworkingv1betaconnection)
4836 if err != nil {
4837 return nil, err
4838 }
4839 c.urlParams_.Set("alt", alt)
4840 c.urlParams_.Set("prettyPrint", "false")
4841 urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+parent}/connections")
4842 urls += "?" + c.urlParams_.Encode()
4843 req, err := http.NewRequest("POST", urls, body)
4844 if err != nil {
4845 return nil, err
4846 }
4847 req.Header = reqHeaders
4848 googleapi.Expand(req.URL, map[string]string{
4849 "parent": c.parent,
4850 })
4851 c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "servicenetworking.services.connections.create", "request", internallog.HTTPRequest(req, body.Bytes()))
4852 return gensupport.SendRequest(c.ctx_, c.s.client, req)
4853 }
4854
4855 // Do executes the "servicenetworking.services.connections.create" call.
4856 // Any non-2xx status code is an error. Response headers are in either
4857 // *Operation.ServerResponse.Header or (if a response was returned at all) in
4858 // error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
4859 // whether the returned error was because http.StatusNotModified was returned.
4860 func (c *ServicesConnectionsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
4861 gensupport.SetOptions(c.urlParams_, opts...)
4862 res, err := c.doRequest("json")
4863 if res != nil && res.StatusCode == http.StatusNotModified {
4864 if res.Body != nil {
4865 res.Body.Close()
4866 }
4867 return nil, gensupport.WrapError(&googleapi.Error{
4868 Code: res.StatusCode,
4869 Header: res.Header,
4870 })
4871 }
4872 if err != nil {
4873 return nil, err
4874 }
4875 defer googleapi.CloseBody(res)
4876 if err := googleapi.CheckResponse(res); err != nil {
4877 return nil, gensupport.WrapError(err)
4878 }
4879 ret := &Operation{
4880 ServerResponse: googleapi.ServerResponse{
4881 Header: res.Header,
4882 HTTPStatusCode: res.StatusCode,
4883 },
4884 }
4885 target := &ret
4886 b, err := gensupport.DecodeResponseBytes(target, res)
4887 if err != nil {
4888 return nil, err
4889 }
4890 c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "servicenetworking.services.connections.create", "response", internallog.HTTPResponse(res, b))
4891 return ret, nil
4892 }
4893
4894 type ServicesConnectionsListCall struct {
4895 s *APIService
4896 parent string
4897 urlParams_ gensupport.URLParams
4898 ifNoneMatch_ string
4899 ctx_ context.Context
4900 header_ http.Header
4901 }
4902
4903 // List: List the private connections that are configured in a service
4904 // consumer's VPC network.
4905 //
4906 // - parent: The service that is managing peering connectivity for a service
4907 // producer's organization. For Google services that support this
4908 // functionality, this value is `services/servicenetworking.googleapis.com`.
4909 // If you specify `-` as the parameter value, all configured public peering
4910 // services are listed.
4911 func (r *ServicesConnectionsService) List(parent string) *ServicesConnectionsListCall {
4912 c := &ServicesConnectionsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
4913 c.parent = parent
4914 return c
4915 }
4916
4917 // Network sets the optional parameter "network": The name of service
4918 // consumer's VPC network that's connected with service producer network
4919 // through a private connection. The network name must be in the following
4920 // format: `projects/{project}/global/networks/{network}`. {project} is a
4921 // project number, such as in `12345` that includes the VPC service consumer's
4922 // VPC network. {network} is the name of the service consumer's VPC network.
4923 func (c *ServicesConnectionsListCall) Network(network string) *ServicesConnectionsListCall {
4924 c.urlParams_.Set("network", network)
4925 return c
4926 }
4927
4928 // Fields allows partial responses to be retrieved. See
4929 // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
4930 // details.
4931 func (c *ServicesConnectionsListCall) Fields(s ...googleapi.Field) *ServicesConnectionsListCall {
4932 c.urlParams_.Set("fields", googleapi.CombineFields(s))
4933 return c
4934 }
4935
4936 // IfNoneMatch sets an optional parameter which makes the operation fail if the
4937 // object's ETag matches the given value. This is useful for getting updates
4938 // only after the object has changed since the last request.
4939 func (c *ServicesConnectionsListCall) IfNoneMatch(entityTag string) *ServicesConnectionsListCall {
4940 c.ifNoneMatch_ = entityTag
4941 return c
4942 }
4943
4944 // Context sets the context to be used in this call's Do method.
4945 func (c *ServicesConnectionsListCall) Context(ctx context.Context) *ServicesConnectionsListCall {
4946 c.ctx_ = ctx
4947 return c
4948 }
4949
4950 // Header returns a http.Header that can be modified by the caller to add
4951 // headers to the request.
4952 func (c *ServicesConnectionsListCall) Header() http.Header {
4953 if c.header_ == nil {
4954 c.header_ = make(http.Header)
4955 }
4956 return c.header_
4957 }
4958
4959 func (c *ServicesConnectionsListCall) doRequest(alt string) (*http.Response, error) {
4960 reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_)
4961 if c.ifNoneMatch_ != "" {
4962 reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
4963 }
4964 c.urlParams_.Set("alt", alt)
4965 c.urlParams_.Set("prettyPrint", "false")
4966 urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+parent}/connections")
4967 urls += "?" + c.urlParams_.Encode()
4968 req, err := http.NewRequest("GET", urls, nil)
4969 if err != nil {
4970 return nil, err
4971 }
4972 req.Header = reqHeaders
4973 googleapi.Expand(req.URL, map[string]string{
4974 "parent": c.parent,
4975 })
4976 c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "servicenetworking.services.connections.list", "request", internallog.HTTPRequest(req, nil))
4977 return gensupport.SendRequest(c.ctx_, c.s.client, req)
4978 }
4979
4980 // Do executes the "servicenetworking.services.connections.list" call.
4981 // Any non-2xx status code is an error. Response headers are in either
4982 // *ListConnectionsResponse.ServerResponse.Header or (if a response was
4983 // returned at all) in error.(*googleapi.Error).Header. Use
4984 // googleapi.IsNotModified to check whether the returned error was because
4985 // http.StatusNotModified was returned.
4986 func (c *ServicesConnectionsListCall) Do(opts ...googleapi.CallOption) (*ListConnectionsResponse, error) {
4987 gensupport.SetOptions(c.urlParams_, opts...)
4988 res, err := c.doRequest("json")
4989 if res != nil && res.StatusCode == http.StatusNotModified {
4990 if res.Body != nil {
4991 res.Body.Close()
4992 }
4993 return nil, gensupport.WrapError(&googleapi.Error{
4994 Code: res.StatusCode,
4995 Header: res.Header,
4996 })
4997 }
4998 if err != nil {
4999 return nil, err
5000 }
5001 defer googleapi.CloseBody(res)
5002 if err := googleapi.CheckResponse(res); err != nil {
5003 return nil, gensupport.WrapError(err)
5004 }
5005 ret := &ListConnectionsResponse{
5006 ServerResponse: googleapi.ServerResponse{
5007 Header: res.Header,
5008 HTTPStatusCode: res.StatusCode,
5009 },
5010 }
5011 target := &ret
5012 b, err := gensupport.DecodeResponseBytes(target, res)
5013 if err != nil {
5014 return nil, err
5015 }
5016 c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "servicenetworking.services.connections.list", "response", internallog.HTTPResponse(res, b))
5017 return ret, nil
5018 }