runtimeconfig

package
v0.209.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 21, 2024 License: BSD-3-Clause Imports: 16 Imported by: 70

Documentation

Overview

Package runtimeconfig provides access to the Cloud Runtime Configuration API.

For product documentation, see: https://cloud.google.com/deployment-manager/runtime-configurator/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/runtimeconfig/v1beta1"
...
ctx := context.Background()
runtimeconfigService, err := runtimeconfig.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes:

runtimeconfigService, err := runtimeconfig.NewService(ctx, option.WithScopes(runtimeconfig.CloudruntimeconfigScope))

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

runtimeconfigService, err := runtimeconfig.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
runtimeconfigService, err := runtimeconfig.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// Manage your Google Cloud Platform services' runtime configuration
	CloudruntimeconfigScope = "https://www.googleapis.com/auth/cloudruntimeconfig"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Binding

type Binding struct {
	// Condition: The condition that is associated with this binding. If the
	// condition evaluates to `true`, then this binding applies to the current
	// request. If the condition evaluates to `false`, then this binding does not
	// apply to the current request. However, a different role binding might grant
	// the same role to one or more of the principals in this binding. To learn
	// which resources support conditions in their IAM policies, see the IAM
	// documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Condition *Expr `json:"condition,omitempty"`
	// Members: Specifies the principals requesting access for a Google Cloud
	// resource. `members` can have the following values: * `allUsers`: A special
	// identifier that represents anyone who is on the internet; with or without a
	// Google account. * `allAuthenticatedUsers`: A special identifier that
	// represents anyone who is authenticated with a Google account or a service
	// account. Does not include identities that come from external identity
	// providers (IdPs) through identity federation. * `user:{emailid}`: An email
	// address that represents a specific Google account. For example,
	// `[email protected]` . * `serviceAccount:{emailid}`: An email address that
	// represents a Google service account. For example,
	// `[email protected]`. *
	// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
	// identifier for a Kubernetes service account
	// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
	// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
	// `group:{emailid}`: An email address that represents a Google group. For
	// example, `[email protected]`. * `domain:{domain}`: The G Suite domain
	// (primary) that represents all the users of that domain. For example,
	// `google.com` or `example.com`. *
	// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/sub
	// ject/{subject_attribute_value}`: A single identity in a workforce identity
	// pool. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// group/{group_id}`: All workforce identities in a group. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// attribute.{attribute_name}/{attribute_value}`: All workforce identities with
	// a specific attribute value. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// *`: All identities in a workforce identity pool. *
	// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo
	// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single
	// identity in a workload identity pool. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool
	// group. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}
	// `: All identities in a workload identity pool with a certain attribute. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/*`: All identities in a workload identity
	// pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a user that has been recently deleted. For
	// example, `[email protected]?uid=123456789012345678901`. If the user is
	// recovered, this value reverts to `user:{emailid}` and the recovered user
	// retains the role in the binding. *
	// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a service account that has been recently
	// deleted. For example,
	// `[email protected]?uid=123456789012345678901`. If the
	// service account is undeleted, this value reverts to
	// `serviceAccount:{emailid}` and the undeleted service account retains the
	// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email
	// address (plus unique identifier) representing a Google group that has been
	// recently deleted. For example,
	// `[email protected]?uid=123456789012345678901`. If the group is recovered,
	// this value reverts to `group:{emailid}` and the recovered group retains the
	// role in the binding. *
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool
	// _id}/subject/{subject_attribute_value}`: Deleted single identity in a
	// workforce identity pool. For example,
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-po
	// ol-id/subject/my-subject-attribute-value`.
	Members []string `json:"members,omitempty"`
	// Role: Role that is assigned to the list of `members`, or principals. For
	// example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview
	// of the IAM roles and permissions, see the IAM documentation
	// (https://cloud.google.com/iam/docs/roles-overview). For a list of the
	// available pre-defined roles, see here
	// (https://cloud.google.com/iam/docs/understanding-roles).
	Role string `json:"role,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Condition") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Condition") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Binding: Associates `members`, or principals, with a `role`.

func (Binding) MarshalJSON

func (s Binding) MarshalJSON() ([]byte, error)

type Cardinality

type Cardinality struct {
	// Number: The number variables under the `path` that must exist to meet this
	// condition. Defaults to 1 if not specified.
	Number int64 `json:"number,omitempty"`
	// Path: The root of the variable subtree to monitor. For example, `/foo`.
	Path string `json:"path,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Number") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Number") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Cardinality: A Cardinality condition for the Waiter resource. A cardinality condition is met when the number of variables under a specified path prefix reaches a predefined number. For example, if you set a Cardinality condition where the `path` is set to `/foo` and the number of paths is set to `2`, the following variables would meet the condition in a RuntimeConfig resource: + `/foo/variable1 = "value1" + `/foo/variable2 = "value2" + `/bar/variable3 = "value3" It would not satisfy the same condition with the `number` set to `3`, however, because there is only 2 paths that start with `/foo`. Cardinality conditions are recursive; all subtrees under the specific path prefix are counted.

func (Cardinality) MarshalJSON

func (s Cardinality) MarshalJSON() ([]byte, error)

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type EndCondition

type EndCondition struct {
	// Cardinality: The cardinality of the `EndCondition`.
	Cardinality *Cardinality `json:"cardinality,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Cardinality") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Cardinality") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EndCondition: The condition that a Waiter resource is waiting for.

func (EndCondition) MarshalJSON

func (s EndCondition) MarshalJSON() ([]byte, error)

type Expr

type Expr struct {
	// Description: Optional. Description of the expression. This is a longer text
	// which describes the expression, e.g. when hovered over it in a UI.
	Description string `json:"description,omitempty"`
	// Expression: Textual representation of an expression in Common Expression
	// Language syntax.
	Expression string `json:"expression,omitempty"`
	// Location: Optional. String indicating the location of the expression for
	// error reporting, e.g. a file name and a position in the file.
	Location string `json:"location,omitempty"`
	// Title: Optional. Title for the expression, i.e. a short string describing
	// its purpose. This can be used e.g. in UIs which allow to enter the
	// expression.
	Title string `json:"title,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Expr: Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

func (Expr) MarshalJSON

func (s Expr) MarshalJSON() ([]byte, error)

type ListConfigsResponse

type ListConfigsResponse struct {
	// Configs: A list of the configurations in the project. The order of returned
	// objects is arbitrary; that is, it is not ordered in any particular way.
	Configs []*RuntimeConfig `json:"configs,omitempty"`
	// NextPageToken: This token allows you to get the next page of results for
	// list requests. If the number of results is larger than `pageSize`, use the
	// `nextPageToken` as a value for the query parameter `pageToken` in the next
	// list request. Subsequent list requests will have their own `nextPageToken`
	// to continue paging through the results
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Configs") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Configs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListConfigsResponse: `ListConfigs()` returns the following response. The order of returned objects is arbitrary; that is, it is not ordered in any particular way.

func (ListConfigsResponse) MarshalJSON

func (s ListConfigsResponse) MarshalJSON() ([]byte, error)

type ListVariablesResponse

type ListVariablesResponse struct {
	// NextPageToken: This token allows you to get the next page of results for
	// list requests. If the number of results is larger than `pageSize`, use the
	// `nextPageToken` as a value for the query parameter `pageToken` in the next
	// list request. Subsequent list requests will have their own `nextPageToken`
	// to continue paging through the results
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Variables: A list of variables and their values. The order of returned
	// variable objects is arbitrary.
	Variables []*Variable `json:"variables,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListVariablesResponse: Response for the `ListVariables()` method.

func (ListVariablesResponse) MarshalJSON

func (s ListVariablesResponse) MarshalJSON() ([]byte, error)

type ListWaitersResponse

type ListWaitersResponse struct {
	// NextPageToken: This token allows you to get the next page of results for
	// list requests. If the number of results is larger than `pageSize`, use the
	// `nextPageToken` as a value for the query parameter `pageToken` in the next
	// list request. Subsequent list requests will have their own `nextPageToken`
	// to continue paging through the results
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Waiters: Found waiters in the project.
	Waiters []*Waiter `json:"waiters,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListWaitersResponse: Response for the `ListWaiters()` method. Order of returned waiter objects is arbitrary.

func (ListWaitersResponse) MarshalJSON

func (s ListWaitersResponse) MarshalJSON() ([]byte, error)

type Operation

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in progress.
	// If `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done bool `json:"done,omitempty"`
	// Error: The error result of the operation in case of failure or cancellation.
	Error *Status `json:"error,omitempty"`
	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as create
	// time. Some services might not provide such metadata. Any method that returns
	// a long-running operation should document the metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: The server-assigned name, which is only unique within the same service
	// that originally returns it. If you use the default HTTP mapping, the `name`
	// should be a resource name ending with `operations/{unique_id}`.
	Name string `json:"name,omitempty"`
	// Response: The normal, successful response of the operation. If the original
	// method returns no data on success, such as `Delete`, the response is
	// `google.protobuf.Empty`. If the original method is standard
	// `Get`/`Create`/`Update`, the response should be the resource. For other
	// methods, the response should have the type `XxxResponse`, where `Xxx` is the
	// original method name. For example, if the original method name is
	// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Done") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (Operation) MarshalJSON

func (s Operation) MarshalJSON() ([]byte, error)

type Policy

type Policy struct {
	// Bindings: Associates a list of `members`, or principals, with a `role`.
	// Optionally, may specify a `condition` that determines how and when the
	// `bindings` are applied. Each of the `bindings` must contain at least one
	// principal. The `bindings` in a `Policy` can refer to up to 1,500 principals;
	// up to 250 of these principals can be Google groups. Each occurrence of a
	// principal counts towards these limits. For example, if the `bindings` grant
	// 50 different roles to `user:[email protected]`, and not to any other
	// principal, then you can add another 1,450 principals to the `bindings` in
	// the `Policy`.
	Bindings []*Binding `json:"bindings,omitempty"`
	// Etag: `etag` is used for optimistic concurrency control as a way to help
	// prevent simultaneous updates of a policy from overwriting each other. It is
	// strongly suggested that systems make use of the `etag` in the
	// read-modify-write cycle to perform policy updates in order to avoid race
	// conditions: An `etag` is returned in the response to `getIamPolicy`, and
	// systems are expected to put that etag in the request to `setIamPolicy` to
	// ensure that their change will be applied to the same version of the policy.
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost.
	Etag string `json:"etag,omitempty"`
	// Version: Specifies the format of the policy. Valid values are `0`, `1`, and
	// `3`. Requests that specify an invalid value are rejected. Any operation that
	// affects conditional role bindings must specify version `3`. This requirement
	// applies to the following operations: * Getting a policy that includes a
	// conditional role binding * Adding a conditional role binding to a policy *
	// Changing a conditional role binding in a policy * Removing any role binding,
	// with or without a condition, from a policy that includes conditions
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost. If a policy does not
	// include any conditions, operations on that policy may specify any valid
	// version or leave the field unset. To learn which resources support
	// conditions in their IAM policies, see the IAM documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Version int64 `json:"version,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Bindings") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Bindings") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

func (Policy) MarshalJSON

func (s Policy) MarshalJSON() ([]byte, error)

type ProjectsConfigsCreateCall

type ProjectsConfigsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsCreateCall) Do

Do executes the "runtimeconfig.projects.configs.create" call. Any non-2xx status code is an error. Response headers are in either *RuntimeConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsConfigsCreateCall) RequestId

RequestId sets the optional parameter "requestId": An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.

type ProjectsConfigsDeleteCall

type ProjectsConfigsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsDeleteCall) Do

Do executes the "runtimeconfig.projects.configs.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsConfigsGetCall

type ProjectsConfigsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsGetCall) Do

Do executes the "runtimeconfig.projects.configs.get" call. Any non-2xx status code is an error. Response headers are in either *RuntimeConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsGetCall) Header

func (c *ProjectsConfigsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsConfigsGetCall) IfNoneMatch

func (c *ProjectsConfigsGetCall) IfNoneMatch(entityTag string) *ProjectsConfigsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsConfigsGetIamPolicyCall

type ProjectsConfigsGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsGetIamPolicyCall) Do

Do executes the "runtimeconfig.projects.configs.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsGetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsConfigsGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsConfigsGetIamPolicyCall) OptionsRequestedPolicyVersion added in v0.8.0

func (c *ProjectsConfigsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsConfigsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsConfigsListCall

type ProjectsConfigsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsListCall) Do

Do executes the "runtimeconfig.projects.configs.list" call. Any non-2xx status code is an error. Response headers are in either *ListConfigsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsListCall) Header

func (c *ProjectsConfigsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsConfigsListCall) IfNoneMatch

func (c *ProjectsConfigsListCall) IfNoneMatch(entityTag string) *ProjectsConfigsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsConfigsListCall) PageSize

func (c *ProjectsConfigsListCall) PageSize(pageSize int64) *ProjectsConfigsListCall

PageSize sets the optional parameter "pageSize": Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.

func (*ProjectsConfigsListCall) PageToken

func (c *ProjectsConfigsListCall) PageToken(pageToken string) *ProjectsConfigsListCall

PageToken sets the optional parameter "pageToken": Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.

func (*ProjectsConfigsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsConfigsOperationsGetCall

type ProjectsConfigsOperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsOperationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsOperationsGetCall) Do

Do executes the "runtimeconfig.projects.configs.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsOperationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsOperationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsConfigsOperationsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsConfigsOperationsService

type ProjectsConfigsOperationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsConfigsOperationsService

func NewProjectsConfigsOperationsService(s *Service) *ProjectsConfigsOperationsService

func (*ProjectsConfigsOperationsService) Get

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

- name: The name of the operation resource.

func (*ProjectsConfigsOperationsService) TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsConfigsOperationsTestIamPermissionsCall

type ProjectsConfigsOperationsTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsOperationsTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsOperationsTestIamPermissionsCall) Do

Do executes the "runtimeconfig.projects.configs.operations.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsOperationsTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsOperationsTestIamPermissionsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsConfigsService

type ProjectsConfigsService struct {
	Operations *ProjectsConfigsOperationsService

	Variables *ProjectsConfigsVariablesService

	Waiters *ProjectsConfigsWaitersService
	// contains filtered or unexported fields
}

func NewProjectsConfigsService

func NewProjectsConfigsService(s *Service) *ProjectsConfigsService

func (*ProjectsConfigsService) Create

func (r *ProjectsConfigsService) Create(parent string, runtimeconfig *RuntimeConfig) *ProjectsConfigsCreateCall

Create: Creates a new RuntimeConfig resource. The configuration name must be unique within project.

func (*ProjectsConfigsService) Delete

Delete: Deletes a RuntimeConfig resource.

  • name: The RuntimeConfig resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.

func (*ProjectsConfigsService) Get

Get: Gets information about a RuntimeConfig resource.

  • name: The name of the RuntimeConfig resource to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.

func (*ProjectsConfigsService) GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

func (*ProjectsConfigsService) List

List: Lists all the RuntimeConfig resources within project.

func (*ProjectsConfigsService) SetIamPolicy

func (r *ProjectsConfigsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsConfigsSetIamPolicyCall

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func (*ProjectsConfigsService) TestIamPermissions

func (r *ProjectsConfigsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsConfigsTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

func (*ProjectsConfigsService) Update

func (r *ProjectsConfigsService) Update(name string, runtimeconfig *RuntimeConfig) *ProjectsConfigsUpdateCall

Update: Updates a RuntimeConfig resource. The configuration must exist beforehand.

  • name: The name of the RuntimeConfig resource to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.

type ProjectsConfigsSetIamPolicyCall

type ProjectsConfigsSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsSetIamPolicyCall) Do

Do executes the "runtimeconfig.projects.configs.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsSetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsConfigsTestIamPermissionsCall

type ProjectsConfigsTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsTestIamPermissionsCall) Do

Do executes the "runtimeconfig.projects.configs.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsTestIamPermissionsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsConfigsUpdateCall

type ProjectsConfigsUpdateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsUpdateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsUpdateCall) Do

Do executes the "runtimeconfig.projects.configs.update" call. Any non-2xx status code is an error. Response headers are in either *RuntimeConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsUpdateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsConfigsVariablesCreateCall

type ProjectsConfigsVariablesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsVariablesCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsVariablesCreateCall) Do

Do executes the "runtimeconfig.projects.configs.variables.create" call. Any non-2xx status code is an error. Response headers are in either *Variable.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsVariablesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsVariablesCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsConfigsVariablesCreateCall) RequestId

RequestId sets the optional parameter "requestId": An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.

type ProjectsConfigsVariablesDeleteCall

type ProjectsConfigsVariablesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsVariablesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsVariablesDeleteCall) Do

Do executes the "runtimeconfig.projects.configs.variables.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsVariablesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsVariablesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsConfigsVariablesDeleteCall) Recursive

Recursive sets the optional parameter "recursive": Set to `true` to recursively delete multiple variables with the same prefix.

type ProjectsConfigsVariablesGetCall

type ProjectsConfigsVariablesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsVariablesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsVariablesGetCall) Do

Do executes the "runtimeconfig.projects.configs.variables.get" call. Any non-2xx status code is an error. Response headers are in either *Variable.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsVariablesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsVariablesGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsConfigsVariablesGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsConfigsVariablesListCall

type ProjectsConfigsVariablesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsVariablesListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsVariablesListCall) Do

Do executes the "runtimeconfig.projects.configs.variables.list" call. Any non-2xx status code is an error. Response headers are in either *ListVariablesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsVariablesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsVariablesListCall) Filter

Filter sets the optional parameter "filter": Filters variables by matching the specified filter. For example: `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.

func (*ProjectsConfigsVariablesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsConfigsVariablesListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsConfigsVariablesListCall) PageSize

PageSize sets the optional parameter "pageSize": Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.

func (*ProjectsConfigsVariablesListCall) PageToken

PageToken sets the optional parameter "pageToken": Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.

func (*ProjectsConfigsVariablesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsConfigsVariablesListCall) ReturnValues

ReturnValues sets the optional parameter "returnValues": The flag indicates whether the user wants to return values of variables. If true, then only those variables that user has IAM GetVariable permission will be returned along with their values.

type ProjectsConfigsVariablesService

type ProjectsConfigsVariablesService struct {
	// contains filtered or unexported fields
}

func NewProjectsConfigsVariablesService

func NewProjectsConfigsVariablesService(s *Service) *ProjectsConfigsVariablesService

func (*ProjectsConfigsVariablesService) Create

Create: Creates a variable within the given configuration. You cannot create a variable with a name that is a prefix of an existing variable name, or a name that has an existing variable name as a prefix. To learn more about creating a variable, read the Setting and Getting Data (/deployment-manager/runtime-configurator/set-and-get-variables) documentation.

  • parent: The path to the RutimeConfig resource that this variable should belong to. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.

func (*ProjectsConfigsVariablesService) Delete

Delete: Deletes a variable or multiple variables. If you specify a variable name, then that variable is deleted. If you specify a prefix and `recursive` is true, then all variables with that prefix are deleted. You must set a `recursive` to true if you delete variables by prefix.

  • name: The name of the variable to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`.

func (*ProjectsConfigsVariablesService) Get

Get: Gets information about a single variable.

  • name: The name of the variable to return, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`.

func (*ProjectsConfigsVariablesService) List

List: Lists variables within given a configuration, matching any provided filters. This only lists variable names, not the values, unless `return_values` is true, in which case only variables that user has IAM permission to GetVariable will be returned.

  • parent: The path to the RuntimeConfig resource for which you want to list variables. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.

func (*ProjectsConfigsVariablesService) TestIamPermissions

func (r *ProjectsConfigsVariablesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsConfigsVariablesTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

func (*ProjectsConfigsVariablesService) Update

Update: Updates an existing variable with a new value.

  • name: The name of the variable to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`.

func (*ProjectsConfigsVariablesService) Watch

Watch: Watches a specific variable and waits for a change in the variable's value. When there is a change, this method returns the new value or times out. If a variable is deleted while being watched, the `variableState` state is set to `DELETED` and the method returns the last known variable `value`. If you set the deadline for watching to a larger value than internal timeout (60 seconds), the current variable value is returned and the `variableState` will be `VARIABLE_STATE_UNSPECIFIED`. To learn more about creating a watcher, read the Watching a Variable for Changes (/deployment-manager/runtime-configurator/watching-a-variable) documentation.

  • name: The name of the variable to watch, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.

type ProjectsConfigsVariablesTestIamPermissionsCall

type ProjectsConfigsVariablesTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsVariablesTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsVariablesTestIamPermissionsCall) Do

Do executes the "runtimeconfig.projects.configs.variables.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsVariablesTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsVariablesTestIamPermissionsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsConfigsVariablesUpdateCall

type ProjectsConfigsVariablesUpdateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsVariablesUpdateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsVariablesUpdateCall) Do

Do executes the "runtimeconfig.projects.configs.variables.update" call. Any non-2xx status code is an error. Response headers are in either *Variable.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsVariablesUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsVariablesUpdateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsConfigsVariablesWatchCall

type ProjectsConfigsVariablesWatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsVariablesWatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsVariablesWatchCall) Do

Do executes the "runtimeconfig.projects.configs.variables.watch" call. Any non-2xx status code is an error. Response headers are in either *Variable.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsVariablesWatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsVariablesWatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsConfigsWaitersCreateCall

type ProjectsConfigsWaitersCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsWaitersCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsWaitersCreateCall) Do

Do executes the "runtimeconfig.projects.configs.waiters.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsWaitersCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsWaitersCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsConfigsWaitersCreateCall) RequestId

RequestId sets the optional parameter "requestId": An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.

type ProjectsConfigsWaitersDeleteCall

type ProjectsConfigsWaitersDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsWaitersDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsWaitersDeleteCall) Do

Do executes the "runtimeconfig.projects.configs.waiters.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsWaitersDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsWaitersDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsConfigsWaitersGetCall

type ProjectsConfigsWaitersGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsWaitersGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsWaitersGetCall) Do

Do executes the "runtimeconfig.projects.configs.waiters.get" call. Any non-2xx status code is an error. Response headers are in either *Waiter.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsWaitersGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsWaitersGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsConfigsWaitersGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsConfigsWaitersListCall

type ProjectsConfigsWaitersListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsWaitersListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsWaitersListCall) Do

Do executes the "runtimeconfig.projects.configs.waiters.list" call. Any non-2xx status code is an error. Response headers are in either *ListWaitersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsWaitersListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsWaitersListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsConfigsWaitersListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsConfigsWaitersListCall) PageSize

PageSize sets the optional parameter "pageSize": Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.

func (*ProjectsConfigsWaitersListCall) PageToken

PageToken sets the optional parameter "pageToken": Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.

func (*ProjectsConfigsWaitersListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsConfigsWaitersService

type ProjectsConfigsWaitersService struct {
	// contains filtered or unexported fields
}

func NewProjectsConfigsWaitersService

func NewProjectsConfigsWaitersService(s *Service) *ProjectsConfigsWaitersService

func (*ProjectsConfigsWaitersService) Create

Create: Creates a Waiter resource. This operation returns a long-running Operation resource which can be polled for completion. However, a waiter with the given name will exist (and can be retrieved) prior to the operation completing. If the operation fails, the failed Waiter resource will still exist and must be deleted prior to subsequent creation attempts.

  • parent: The path to the configuration that will own the waiter. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.

func (*ProjectsConfigsWaitersService) Delete

Delete: Deletes the waiter with the specified name.

  • name: The Waiter resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`.

func (*ProjectsConfigsWaitersService) Get

Get: Gets information about a single waiter.

  • name: The fully-qualified name of the Waiter resource object to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`.

func (*ProjectsConfigsWaitersService) List

List: List waiters within the given configuration.

  • parent: The path to the configuration for which you want to get a list of waiters. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.

func (*ProjectsConfigsWaitersService) TestIamPermissions

func (r *ProjectsConfigsWaitersService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsConfigsWaitersTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsConfigsWaitersTestIamPermissionsCall

type ProjectsConfigsWaitersTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsConfigsWaitersTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsConfigsWaitersTestIamPermissionsCall) Do

Do executes the "runtimeconfig.projects.configs.waiters.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsConfigsWaitersTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsConfigsWaitersTestIamPermissionsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsService

type ProjectsService struct {
	Configs *ProjectsConfigsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type RuntimeConfig

type RuntimeConfig struct {
	// Description: An optional description of the RuntimeConfig object.
	Description string `json:"description,omitempty"`
	// Name: The resource name of a runtime config. The name must have the format:
	// projects/[PROJECT_ID]/configs/[CONFIG_NAME] The `[PROJECT_ID]` must be a
	// valid project ID, and `[CONFIG_NAME]` is an arbitrary name that matches the
	// `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression. The
	// length of `[CONFIG_NAME]` must be less than 64 characters. You pick the
	// RuntimeConfig resource name, but the server will validate that the name
	// adheres to this format. After you create the resource, you cannot change the
	// resource's name.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RuntimeConfig: A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig service. A RuntimeConfig resource consists of metadata and a hierarchy of variables.

func (RuntimeConfig) MarshalJSON

func (s RuntimeConfig) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SetIamPolicyRequest

type SetIamPolicyRequest struct {
	// Policy: REQUIRED: The complete policy to be applied to the `resource`. The
	// size of the policy is limited to a few 10s of KB. An empty policy is a valid
	// policy but certain Google Cloud services (such as Projects) might reject
	// them.
	Policy *Policy `json:"policy,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Policy") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Policy") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (SetIamPolicyRequest) MarshalJSON

func (s SetIamPolicyRequest) MarshalJSON() ([]byte, error)

type Status

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `json:"code,omitempty"`
	// Details: A list of messages that carry the error details. There is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`
	// Message: A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Code") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

type TestIamPermissionsRequest

type TestIamPermissionsRequest struct {
	// Permissions: The set of permissions to check for the `resource`. Permissions
	// with wildcards (such as `*` or `storage.*`) are not allowed. For more
	// information see IAM Overview
	// (https://cloud.google.com/iam/docs/overview#permissions).
	Permissions []string `json:"permissions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Permissions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (TestIamPermissionsRequest) MarshalJSON

func (s TestIamPermissionsRequest) MarshalJSON() ([]byte, error)

type TestIamPermissionsResponse

type TestIamPermissionsResponse struct {
	// Permissions: A subset of `TestPermissionsRequest.permissions` that the
	// caller is allowed.
	Permissions []string `json:"permissions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Permissions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (TestIamPermissionsResponse) MarshalJSON

func (s TestIamPermissionsResponse) MarshalJSON() ([]byte, error)

type Variable

type Variable struct {
	// Name: The name of the variable resource, in the format:
	// projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME] The
	// `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a valid
	// RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system file
	// path naming. The `[VARIABLE_NAME]` can contain ASCII letters, numbers,
	// slashes and dashes. Slashes are used as path element separators and are not
	// part of the `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at
	// least one non-slash character. Multiple slashes are coalesced into single
	// slash character. Each path segment should match 0-9A-Za-z
	// (?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression. The length of a
	// `[VARIABLE_NAME]` must be less than 256 characters. Once you create a
	// variable, you cannot change the variable name.
	Name string `json:"name,omitempty"`
	// State: Output only. The current state of the variable. The variable state
	// indicates the outcome of the `variables().watch` call and is visible through
	// the `get` and `list` calls.
	//
	// Possible values:
	//   "VARIABLE_STATE_UNSPECIFIED" - Default variable state.
	//   "UPDATED" - The variable was updated, while `variables().watch` was
	// executing.
	//   "DELETED" - The variable was deleted, while `variables().watch` was
	// executing.
	State string `json:"state,omitempty"`
	// Text: The string value of the variable. The length of the value must be less
	// than 4096 bytes. Empty values are also accepted. For example, `text: "my
	// text value". The string must be valid UTF-8.
	Text string `json:"text,omitempty"`
	// UpdateTime: Output only. The time of the last variable update. Timestamp
	// will be UTC timestamp.
	UpdateTime string `json:"updateTime,omitempty"`
	// Value: The binary value of the variable. The length of the value must be
	// less than 4096 bytes. Empty values are also accepted. The value must be
	// base64 encoded, and must comply with IETF RFC4648
	// (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text` can be
	// set.
	Value string `json:"value,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Variable: Describes a single variable within a RuntimeConfig resource. The name denotes the hierarchical variable name. For example, `ports/serving_port` is a valid variable name. The variable value is an opaque string and only leaf variables can have values (that is, variables that do not have any child variables).

func (Variable) MarshalJSON

func (s Variable) MarshalJSON() ([]byte, error)

type Waiter

type Waiter struct {
	// CreateTime: Output only. The instant at which this Waiter resource was
	// created. Adding the value of `timeout` to this instant yields the timeout
	// deadline for the waiter.
	CreateTime string `json:"createTime,omitempty"`
	// Done: Output only. If the value is `false`, it means the waiter is still
	// waiting for one of its conditions to be met. If true, the waiter has
	// finished. If the waiter finished due to a timeout or failure, `error` will
	// be set.
	Done bool `json:"done,omitempty"`
	// Error: Output only. If the waiter ended due to a failure or timeout, this
	// value will be set.
	Error *Status `json:"error,omitempty"`
	// Failure: [Optional] The failure condition of this waiter. If this condition
	// is met, `done` will be set to `true` and the `error` code will be set to
	// `ABORTED`. The failure condition takes precedence over the success
	// condition. If both conditions are met, a failure will be indicated. This
	// value is optional; if no failure condition is set, the only failure scenario
	// will be a timeout.
	Failure *EndCondition `json:"failure,omitempty"`
	// Name: The name of the Waiter resource, in the format:
	// projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME] The
	// `[PROJECT_ID]` must be a valid Google Cloud project ID, the `[CONFIG_NAME]`
	// must be a valid RuntimeConfig resource, the `[WAITER_NAME]` must match RFC
	// 1035 segment specification, and the length of `[WAITER_NAME]` must be less
	// than 64 bytes. After you create a Waiter resource, you cannot change the
	// resource name.
	Name string `json:"name,omitempty"`
	// Success: [Required] The success condition. If this condition is met, `done`
	// will be set to `true` and the `error` value will remain unset. The failure
	// condition takes precedence over the success condition. If both conditions
	// are met, a failure will be indicated.
	Success *EndCondition `json:"success,omitempty"`
	// Timeout: [Required] Specifies the timeout of the waiter in seconds,
	// beginning from the instant that `waiters().create` method is called. If this
	// time elapses before the success or failure conditions are met, the waiter
	// fails and sets the `error` code to `DEADLINE_EXCEEDED`.
	Timeout string `json:"timeout,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Waiter: A Waiter resource waits for some end condition within a RuntimeConfig resource to be met before it returns. For example, assume you have a distributed system where each node writes to a Variable resource indicating the node's readiness as part of the startup process. You then configure a Waiter resource with the success condition set to wait until some number of nodes have checked in. Afterwards, your application runs some arbitrary code after the condition has been met and the waiter returns successfully. Once created, a Waiter resource is immutable. To learn more about using waiters, read the Creating a Waiter (/deployment-manager/runtime-configurator/creating-a-waiter) documentation.

func (Waiter) MarshalJSON

func (s Waiter) MarshalJSON() ([]byte, error)

type WatchVariableRequest

type WatchVariableRequest struct {
	// NewerThan: If specified, checks the current timestamp of the variable and if
	// the current timestamp is newer than `newerThan` timestamp, the method
	// returns immediately. If not specified or the variable has an older
	// timestamp, the watcher waits for a the value to change before returning.
	NewerThan string `json:"newerThan,omitempty"`
	// ForceSendFields is a list of field names (e.g. "NewerThan") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NewerThan") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

WatchVariableRequest: Request for the `WatchVariable()` method.

func (WatchVariableRequest) MarshalJSON

func (s WatchVariableRequest) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL