runtimeconfig

package
v0.0.0-...-6bc9e77 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2016 License: BSD-3-Clause Imports: 13 Imported by: 0

Documentation

Overview

Package runtimeconfig provides access to the Google Cloud RuntimeConfig API.

See https://cloud.google.com/deployment-manager/runtime-configurator/

Usage example: 

import "google.golang.org/api/runtimeconfig/v1beta1"
...
runtimeconfigService, err := runtimeconfig.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// View and manage your data across Google Cloud Platform services
	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 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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 would not satisify 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); 

}

The JSON representation for `Empty` is empty JSON object `{}`.

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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*EndCondition) MarshalJSON 

func (s *EndCondition) 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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 OperationMetadata `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 have the format of `operations/some/unique/name`.
	Name string `json:"name,omitempty"`

	// Response: The normal response of the operation in case of success.
	// 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 OperationResponse `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 OperationMetadata 

type OperationMetadata interface{}

type OperationResponse 

type OperationResponse interface{}

type ProjectsConfigsCreateCall 

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

func (*ProjectsConfigsCreateCall) Context 

func (c *ProjectsConfigsCreateCall) Context(ctx context.Context) *ProjectsConfigsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsCreateCall) Do 

func (c *ProjectsConfigsCreateCall) Do(opts ...googleapi.CallOption) (*RuntimeConfig, error)

Do executes the "runtimeconfig.projects.configs.create" call. Exactly one of *RuntimeConfig or error will be non-nil. 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 

func (c *ProjectsConfigsCreateCall) Fields(s ...googleapi.Field) *ProjectsConfigsCreateCall

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

func (*ProjectsConfigsCreateCall) RequestId 

func (c *ProjectsConfigsCreateCall) RequestId(requestId string) *ProjectsConfigsCreateCall

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

type ProjectsConfigsDeleteCall 

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

func (*ProjectsConfigsDeleteCall) Context 

func (c *ProjectsConfigsDeleteCall) Context(ctx context.Context) *ProjectsConfigsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsDeleteCall) Do 

func (c *ProjectsConfigsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "runtimeconfig.projects.configs.delete" call. Exactly one of *Empty or error will be non-nil. 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 

func (c *ProjectsConfigsDeleteCall) Fields(s ...googleapi.Field) *ProjectsConfigsDeleteCall

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

type ProjectsConfigsGetCall 

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

func (*ProjectsConfigsGetCall) Context 

func (c *ProjectsConfigsGetCall) Context(ctx context.Context) *ProjectsConfigsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsGetCall) Do 

func (c *ProjectsConfigsGetCall) Do(opts ...googleapi.CallOption) (*RuntimeConfig, error)

Do executes the "runtimeconfig.projects.configs.get" call. Exactly one of *RuntimeConfig or error will be non-nil. 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 

func (c *ProjectsConfigsGetCall) Fields(s ...googleapi.Field) *ProjectsConfigsGetCall

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

func (*ProjectsConfigsGetCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsConfigsListCall 

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

func (*ProjectsConfigsListCall) Context 

func (c *ProjectsConfigsListCall) Context(ctx context.Context) *ProjectsConfigsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsListCall) Do 

func (c *ProjectsConfigsListCall) Do(opts ...googleapi.CallOption) (*ListConfigsResponse, error)

Do executes the "runtimeconfig.projects.configs.list" call. Exactly one of *ListConfigsResponse or error will be non-nil. 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 

func (c *ProjectsConfigsListCall) Fields(s ...googleapi.Field) *ProjectsConfigsListCall

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

func (*ProjectsConfigsListCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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 

func (c *ProjectsConfigsListCall) Pages(ctx context.Context, f func(*ListConfigsResponse) error) error

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 

func (c *ProjectsConfigsOperationsGetCall) Context(ctx context.Context) *ProjectsConfigsOperationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsOperationsGetCall) Do 

func (c *ProjectsConfigsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "runtimeconfig.projects.configs.operations.get" call. Exactly one of *Operation or error will be non-nil. 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 

func (c *ProjectsConfigsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsConfigsOperationsGetCall

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

func (*ProjectsConfigsOperationsGetCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsConfigsOperationsService 

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

func NewProjectsConfigsOperationsService 

func NewProjectsConfigsOperationsService(s *Service) *ProjectsConfigsOperationsService

func (*ProjectsConfigsOperationsService) Get 

func (r *ProjectsConfigsOperationsService) Get(name string) *ProjectsConfigsOperationsGetCall

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.

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 

func (r *ProjectsConfigsService) Delete(name string) *ProjectsConfigsDeleteCall

Delete: Deletes a RuntimeConfig resource.

func (*ProjectsConfigsService) Get 

func (r *ProjectsConfigsService) Get(name string) *ProjectsConfigsGetCall

Get: Gets information about a RuntimeConfig resource.

func (*ProjectsConfigsService) List 

func (r *ProjectsConfigsService) List(parent string) *ProjectsConfigsListCall

List: Lists all the RuntimeConfig resources within project.

func (*ProjectsConfigsService) Update 

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

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

type ProjectsConfigsUpdateCall 

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

func (*ProjectsConfigsUpdateCall) Context 

func (c *ProjectsConfigsUpdateCall) Context(ctx context.Context) *ProjectsConfigsUpdateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsUpdateCall) Do 

func (c *ProjectsConfigsUpdateCall) Do(opts ...googleapi.CallOption) (*RuntimeConfig, error)

Do executes the "runtimeconfig.projects.configs.update" call. Exactly one of *RuntimeConfig or error will be non-nil. 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 

func (c *ProjectsConfigsUpdateCall) Fields(s ...googleapi.Field) *ProjectsConfigsUpdateCall

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

type ProjectsConfigsVariablesCreateCall 

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

func (*ProjectsConfigsVariablesCreateCall) Context 

func (c *ProjectsConfigsVariablesCreateCall) Context(ctx context.Context) *ProjectsConfigsVariablesCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsVariablesCreateCall) Do 

func (c *ProjectsConfigsVariablesCreateCall) Do(opts ...googleapi.CallOption) (*Variable, error)

Do executes the "runtimeconfig.projects.configs.variables.create" call. Exactly one of *Variable or error will be non-nil. 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 

func (c *ProjectsConfigsVariablesCreateCall) Fields(s ...googleapi.Field) *ProjectsConfigsVariablesCreateCall

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

func (*ProjectsConfigsVariablesCreateCall) RequestId 

func (c *ProjectsConfigsVariablesCreateCall) RequestId(requestId string) *ProjectsConfigsVariablesCreateCall

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

type ProjectsConfigsVariablesDeleteCall 

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

func (*ProjectsConfigsVariablesDeleteCall) Context 

func (c *ProjectsConfigsVariablesDeleteCall) Context(ctx context.Context) *ProjectsConfigsVariablesDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsVariablesDeleteCall) Do 

func (c *ProjectsConfigsVariablesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "runtimeconfig.projects.configs.variables.delete" call. Exactly one of *Empty or error will be non-nil. 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 

func (c *ProjectsConfigsVariablesDeleteCall) Fields(s ...googleapi.Field) *ProjectsConfigsVariablesDeleteCall

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

func (*ProjectsConfigsVariablesDeleteCall) Recursive 

func (c *ProjectsConfigsVariablesDeleteCall) Recursive(recursive bool) *ProjectsConfigsVariablesDeleteCall

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 

func (c *ProjectsConfigsVariablesGetCall) Context(ctx context.Context) *ProjectsConfigsVariablesGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsVariablesGetCall) Do 

func (c *ProjectsConfigsVariablesGetCall) Do(opts ...googleapi.CallOption) (*Variable, error)

Do executes the "runtimeconfig.projects.configs.variables.get" call. Exactly one of *Variable or error will be non-nil. 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 

func (c *ProjectsConfigsVariablesGetCall) Fields(s ...googleapi.Field) *ProjectsConfigsVariablesGetCall

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

func (*ProjectsConfigsVariablesGetCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsConfigsVariablesListCall 

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

func (*ProjectsConfigsVariablesListCall) Context 

func (c *ProjectsConfigsVariablesListCall) Context(ctx context.Context) *ProjectsConfigsVariablesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsVariablesListCall) Do 

func (c *ProjectsConfigsVariablesListCall) Do(opts ...googleapi.CallOption) (*ListVariablesResponse, error)

Do executes the "runtimeconfig.projects.configs.variables.list" call. Exactly one of *ListVariablesResponse or error will be non-nil. 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 

func (c *ProjectsConfigsVariablesListCall) Fields(s ...googleapi.Field) *ProjectsConfigsVariablesListCall

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

func (*ProjectsConfigsVariablesListCall) Filter 

func (c *ProjectsConfigsVariablesListCall) Filter(filter string) *ProjectsConfigsVariablesListCall

Filter sets the optional parameter "filter": Filters variables by matching the specified filter. For example:

`projects/example-project/config/[CONFIG_NAME]/variables/exa mple-variable`.

func (*ProjectsConfigsVariablesListCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsConfigsVariablesListCall) PageSize 

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

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 

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

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 

func (c *ProjectsConfigsVariablesListCall) Pages(ctx context.Context, f func(*ListVariablesResponse) error) error

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 ProjectsConfigsVariablesService 

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

func NewProjectsConfigsVariablesService 

func NewProjectsConfigsVariablesService(s *Service) *ProjectsConfigsVariablesService

func (*ProjectsConfigsVariablesService) Create 

func (r *ProjectsConfigsVariablesService) Create(parent string, variable *Variable) *ProjectsConfigsVariablesCreateCall

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.

func (*ProjectsConfigsVariablesService) Delete 

func (r *ProjectsConfigsVariablesService) Delete(name string) *ProjectsConfigsVariablesDeleteCall

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.

func (*ProjectsConfigsVariablesService) Get 

func (r *ProjectsConfigsVariablesService) Get(name string) *ProjectsConfigsVariablesGetCall

Get: Gets information about a single variable.

func (*ProjectsConfigsVariablesService) List 

func (r *ProjectsConfigsVariablesService) List(parent string) *ProjectsConfigsVariablesListCall

List: Lists variables within given a configuration, matching any provided filters. This only lists variable names, not the values.

func (*ProjectsConfigsVariablesService) Update 

func (r *ProjectsConfigsVariablesService) Update(name string, variable *Variable) *ProjectsConfigsVariablesUpdateCall

Update: Updates an existing variable with a new value.

func (*ProjectsConfigsVariablesService) Watch 

func (r *ProjectsConfigsVariablesService) Watch(name string, watchvariablerequest *WatchVariableRequest) *ProjectsConfigsVariablesWatchCall

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.

type ProjectsConfigsVariablesUpdateCall 

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

func (*ProjectsConfigsVariablesUpdateCall) Context 

func (c *ProjectsConfigsVariablesUpdateCall) Context(ctx context.Context) *ProjectsConfigsVariablesUpdateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsVariablesUpdateCall) Do 

func (c *ProjectsConfigsVariablesUpdateCall) Do(opts ...googleapi.CallOption) (*Variable, error)

Do executes the "runtimeconfig.projects.configs.variables.update" call. Exactly one of *Variable or error will be non-nil. 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 

func (c *ProjectsConfigsVariablesUpdateCall) Fields(s ...googleapi.Field) *ProjectsConfigsVariablesUpdateCall

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

type ProjectsConfigsVariablesWatchCall 

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

func (*ProjectsConfigsVariablesWatchCall) Context 

func (c *ProjectsConfigsVariablesWatchCall) Context(ctx context.Context) *ProjectsConfigsVariablesWatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsVariablesWatchCall) Do 

func (c *ProjectsConfigsVariablesWatchCall) Do(opts ...googleapi.CallOption) (*Variable, error)

Do executes the "runtimeconfig.projects.configs.variables.watch" call. Exactly one of *Variable or error will be non-nil. 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 

func (c *ProjectsConfigsVariablesWatchCall) Fields(s ...googleapi.Field) *ProjectsConfigsVariablesWatchCall

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

type ProjectsConfigsWaitersCreateCall 

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

func (*ProjectsConfigsWaitersCreateCall) Context 

func (c *ProjectsConfigsWaitersCreateCall) Context(ctx context.Context) *ProjectsConfigsWaitersCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsWaitersCreateCall) Do 

func (c *ProjectsConfigsWaitersCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "runtimeconfig.projects.configs.waiters.create" call. Exactly one of *Operation or error will be non-nil. 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 

func (c *ProjectsConfigsWaitersCreateCall) Fields(s ...googleapi.Field) *ProjectsConfigsWaitersCreateCall

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

func (*ProjectsConfigsWaitersCreateCall) RequestId 

func (c *ProjectsConfigsWaitersCreateCall) RequestId(requestId string) *ProjectsConfigsWaitersCreateCall

RequestId sets the optional parameter "requestId": An optional unique request_id. If server receives two Create requests with the same request_id then second request will be ignored and information stored in the backend will be returned. Empty request_id fields are ignored. It is responsibility of the client to ensure uniqueness of the request_id strings. The strings are limited to 64 characters.

type ProjectsConfigsWaitersDeleteCall 

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

func (*ProjectsConfigsWaitersDeleteCall) Context 

func (c *ProjectsConfigsWaitersDeleteCall) Context(ctx context.Context) *ProjectsConfigsWaitersDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsWaitersDeleteCall) Do 

func (c *ProjectsConfigsWaitersDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "runtimeconfig.projects.configs.waiters.delete" call. Exactly one of *Empty or error will be non-nil. 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 

func (c *ProjectsConfigsWaitersDeleteCall) Fields(s ...googleapi.Field) *ProjectsConfigsWaitersDeleteCall

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

type ProjectsConfigsWaitersGetCall 

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

func (*ProjectsConfigsWaitersGetCall) Context 

func (c *ProjectsConfigsWaitersGetCall) Context(ctx context.Context) *ProjectsConfigsWaitersGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsWaitersGetCall) Do 

func (c *ProjectsConfigsWaitersGetCall) Do(opts ...googleapi.CallOption) (*Waiter, error)

Do executes the "runtimeconfig.projects.configs.waiters.get" call. Exactly one of *Waiter or error will be non-nil. 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 

func (c *ProjectsConfigsWaitersGetCall) Fields(s ...googleapi.Field) *ProjectsConfigsWaitersGetCall

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

func (*ProjectsConfigsWaitersGetCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsConfigsWaitersListCall 

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

func (*ProjectsConfigsWaitersListCall) Context 

func (c *ProjectsConfigsWaitersListCall) Context(ctx context.Context) *ProjectsConfigsWaitersListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsWaitersListCall) Do 

func (c *ProjectsConfigsWaitersListCall) Do(opts ...googleapi.CallOption) (*ListWaitersResponse, error)

Do executes the "runtimeconfig.projects.configs.waiters.list" call. Exactly one of *ListWaitersResponse or error will be non-nil. 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 

func (c *ProjectsConfigsWaitersListCall) Fields(s ...googleapi.Field) *ProjectsConfigsWaitersListCall

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

func (*ProjectsConfigsWaitersListCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsConfigsWaitersListCall) PageSize 

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

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 

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

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 

func (c *ProjectsConfigsWaitersListCall) Pages(ctx context.Context, f func(*ListWaitersResponse) error) error

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 

func (r *ProjectsConfigsWaitersService) Create(parent string, waiter *Waiter) *ProjectsConfigsWaitersCreateCall

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.

func (*ProjectsConfigsWaitersService) Delete 

func (r *ProjectsConfigsWaitersService) Delete(name string) *ProjectsConfigsWaitersDeleteCall

Delete: Deletes the waiter with the specified name.

func (*ProjectsConfigsWaitersService) Get 

func (r *ProjectsConfigsWaitersService) Get(name string) *ProjectsConfigsWaitersGetCall

Get: Gets information about a single waiter.

func (*ProjectsConfigsWaitersService) List 

func (r *ProjectsConfigsWaitersService) List(parent string) *ProjectsConfigsWaitersListCall

List: List waiters within the given configuration.

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.
	// The length of the description must be less than 256 bytes.
	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 RFC 1035 segment specification. The
	// length of
	// `[CONFIG_NAME]` must be less than 64 bytes.
	//
	// 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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 

func New(client *http.Client) (*Service, 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 will
	// be a
	// common set of message types for APIs to use.
	Details []StatusDetails `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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). The error model is designed to be:

- Simple to use and understand for most users - Flexible enough to meet unexpected needs

Overview

The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions.

Language mapping

The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.

Other uses

The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.

Example uses of this error model include:

- Partial errors. If a service needs to return partial errors to the client, 

it may embed the `Status` in the normal response to indicate the

partial 

errors.

- Workflow errors. A typical workflow has multiple steps. Each step may 

have a `Status` message for error reporting purpose.

- Batch operations. If a client uses batch request and batch response, the 

`Status` message should be used directly inside batch response,

one for 

each error sub-response.

- Asynchronous operations. If an API call embeds asynchronous operation 

results in its response, the status of those operations should

be 

represented directly using the `Status` message.

- Logging. If some API errors are stored in logs, the message `Status` could 

be used directly after any stripping needed for security/privacy

reasons.

func (*Status) MarshalJSON 

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

type StatusDetails 

type StatusDetails interface{}

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 reource 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 follow RFC 1035 segment
	// specification.
	// The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
	//
	// Once you create a variable, you cannot change the variable name.
	Name string `json:"name,omitempty"`

	// State: [Ouput 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 textual value of the variable. The length of the value must
	// be less
	// than 4096 bytes. Empty values are also accepted.
	// NB: Only one of value and string_value can be set at the same time.
	Text string `json:"text,omitempty"`

	// UpdateTime: [Output Only] The time of the last variable update.
	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.
	// NB: Only one of value and string_value can be set at the same time.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 indidicating 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) do cumentation.

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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*WatchVariableRequest) MarshalJSON 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.