runtimeconfig

package
v0.0.0-...-63ade87 Latest Latest
Warning

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

Go to latest
Published: Jun 1, 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/docs/

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 of decendents of `path` that must exist before
	// this condition
	// is met. Optional; defaults to 1 if not specified.
	Number int64 `json:"number,omitempty"`

	// Path: The root of the variable subtree to monitor. Required.
	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:"-"`
}

Cardinality: The Cardinality condition is met when the count of `Variable` resources under the specified path prefix reaches the specified number. For example, take the following variables in a RuntimeConfig object:

/foo/variable1 = "value1"
/foo/variable2 = "value2"
/bar/variable3 = "value3"

These variables would satisfy a Cardinality condition with `path` set to "/foo" and `number` set to 2, but would not satisify the same condition with `number` set to 3.

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 condition type configuration.
	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:"-"`
}

EndCondition: A condition that a Waiter resource is waiting for. The set of possible conditions may expand over time.

func (*EndCondition) MarshalJSON

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

type ListConfigsResponse

type ListConfigsResponse struct {
	// Configs: Found configurations in the project.
	Configs []*RuntimeConfig `json:"configs,omitempty"`

	// NextPageToken: Pagination support.
	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:"-"`
}

ListConfigsResponse: Response for the `ListConfigs()` method. Order of returned configuration objects is arbitrary.

func (*ListConfigsResponse) MarshalJSON

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

type ListVariablesResponse

type ListVariablesResponse struct {
	// NextPageToken: Pagination support.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Variables: Matched variables and their values.
	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:"-"`
}

ListVariablesResponse: Response for the `ListVariables()` method. Order of returned variable objects is arbitrary.

func (*ListVariablesResponse) MarshalJSON

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

type ListWaitersResponse

type ListWaitersResponse struct {
	// NextPageToken: Pagination support.
	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:"-"`
}

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.
	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:"-"`
}

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

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

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

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

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsDeleteCall) Do

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

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

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

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

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

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

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

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": List pagination support. The size of the page to return. We may return fewer elements.

func (*ProjectsConfigsListCall) PageToken

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

PageToken sets the optional parameter "pageToken": The token for pagination.

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsOperationsGetCall) Do

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

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

func (*ProjectsConfigsOperationsGetCall) IfNoneMatch

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

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: CreateConfig creates a new config resource object. The configuration name must be unique within project.

func (*ProjectsConfigsService) Delete

Delete: Deletes the config object.

func (*ProjectsConfigsService) Get

Get: Gets the config resource object.

func (*ProjectsConfigsService) List

List: Lists all the config objects within project.

func (*ProjectsConfigsService) Update

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

Update: Updates the config resource object. RuntimeConfig object must already exist.

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsUpdateCall) Do

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

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

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

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

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

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsVariablesDeleteCall) Do

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

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

func (*ProjectsConfigsVariablesDeleteCall) Recursive

Recursive sets the optional parameter "recursive": If recursive is false and name is a prefix of other variables, then the request will fail.

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsVariablesGetCall) Do

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

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

func (*ProjectsConfigsVariablesGetCall) IfNoneMatch

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

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

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

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

func (*ProjectsConfigsVariablesListCall) Filter

Filter sets the optional parameter "filter": List only variables matching filter prefix exactly. e.g. `projects/{project_id}/config/{config_id}/variables/{variable/id}`.

func (*ProjectsConfigsVariablesListCall) IfNoneMatch

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

PageSize sets the optional parameter "pageSize": List pagination support. The size of the page to return. We may return fewer elements.

func (*ProjectsConfigsVariablesListCall) PageToken

PageToken sets the optional parameter "pageToken": The token for pagination.

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.

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. Create variable will create all required intermediate path elements. It is a FAILED_PRECONDITION error to create a variable with a name that is a prefix of an existing variable name, or that has an existing variable name as a prefix.

func (*ProjectsConfigsVariablesService) Delete

Delete: Deletes variable or variables. If name denotes a variable, that variable is deleted. If name is a prefix and recursive is true, then all variables with that prefix are deleted, it's a FAILED_PRECONDITION to delete a prefix without recursive being true.

func (*ProjectsConfigsVariablesService) Get

Get: Gets the variable resource object.

func (*ProjectsConfigsVariablesService) List

List: Lists variables within given RuntimeConfig object, matching optionally provided filter. List contains only variable metadata, but not values.

func (*ProjectsConfigsVariablesService) Update

Update: Updates an existing variable with a new value.

func (*ProjectsConfigsVariablesService) Watch

Watch: WatchVariable watches for a variable to change and then returns the new value or times out. If variable is deleted while being watched, VariableState will be DELETED and the Value will contain the last known value. If the operation deadline is set to a larger value than internal timeout existing, current variable value will be returned and Variable state will be VARIABLE_STATE_UNSPECIFIED.

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsVariablesUpdateCall) Do

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

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

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

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

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

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

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

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

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConfigsWaitersDeleteCall) Do

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

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

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

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

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

func (*ProjectsConfigsWaitersGetCall) IfNoneMatch

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

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

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

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

func (*ProjectsConfigsWaitersListCall) IfNoneMatch

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

PageSize sets the optional parameter "pageSize": List pagination support. The size of the page to return. We may return fewer elements.

func (*ProjectsConfigsWaitersListCall) PageToken

PageToken sets the optional parameter "pageToken": The token for pagination.

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 resultant Operation completing. If the resultant Operation indicates a failure, the failed Waiter resource will still exist and must be deleted prior to subsequent creation attempts.

func (*ProjectsConfigsWaitersService) Delete

Delete: Deletes the Waiter with the specified name.

func (*ProjectsConfigsWaitersService) Get

Get: Gets the Waiter resource with the specified name.

func (*ProjectsConfigsWaitersService) List

List: List Waiters within the given RuntimeConfig resource.

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: Description of the configuration
	// object.
	// `len(description)` must be less than 256.
	Description string `json:"description,omitempty"`

	// Name: The resource name of a runtime config.
	// It has the format of
	// "projects/{project_id}/configs/{config_id}",
	// where `project_id` is a valid Google cloud project ID, and
	// the
	// `config_id` must match RFC 1035 segment specification,
	// and
	// `len(config_id)` must be less than 64 bytes.
	// The name is assigned by the client, but will be validated on the
	// server
	// side to adhere to the format.
	// Name is immutable and cannot be changed.
	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:"-"`
}

RuntimeConfig: RuntimeConfig is the primary resource in the Configuration service. It 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:"-"`
}

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: Name of the variable resource.
	// It has format
	// of
	// "projects/{project_id}/configs/{config_id}/variables/{variable_id}"
	// ,
	// Where `project_id` must be a valid Google Cloud project ID,
	// `config_id`
	// must be a valid RuntimeConfig object and `variable_id` follows
	// Unix
	// file system file path naming.
	// `variable_id` can contain ASCII letters, numbers, slashes and
	// dashes.
	// Slashes are used as path element separators and are not part of
	// the
	// `variable_id` itself, so `variable_id` 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.
	// `len(variable_id)` must be less than 256 bytes.
	// The name is assigned by the client, but will be validated on the
	// server
	// side to adhere to the format.
	// Name is immutable and cannot be changed.
	Name string `json:"name,omitempty"`

	// State: [Ouput only] The current state of the variable.
	// State denotes the outcome of the Watch call and is unset by the
	// Get/List
	// calls.
	//
	// Possible values:
	//   "VARIABLE_STATE_UNSPECIFIED" - Default variable state.
	//   "UPDATED" - Variable had been updated, while watch was executing.
	//   "DELETED" - Variable had been deleted, while watch was executing.
	State string `json:"state,omitempty"`

	// UpdateTime: [Output Only] The time of the last variable update.
	UpdateTime string `json:"updateTime,omitempty"`

	// Value: `len(value)` must be less than 4096 bytes. Empty values are
	// also accepted.
	// value must be Base64 encoded.
	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:"-"`
}

Variable: Variable message describes a single variable within a Configuration object. name denotes the hierarchical variable name, e.g. ports/serving_port within flags configuration object. Value is an opaque string and only leaf variables can have values.

func (*Variable) MarshalJSON

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

type Waiter

type Waiter struct {
	// CreateTime: The instant at which this Waiter was created. Adding the
	// value of `timeout`
	// to this instant yields the timeout deadline for this Waiter. Output
	// only.
	CreateTime string `json:"createTime,omitempty"`

	// Done: 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. Output only.
	Done bool `json:"done,omitempty"`

	// Error: If the Waiter ended due to a failure or timeout, this value
	// will be set.
	// Output only.
	//
	Error *Status `json:"error,omitempty"`

	// Failure: The failure condition. 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. Optional.
	Failure *EndCondition `json:"failure,omitempty"`

	// Name: Name of the variable resource.
	// It has format
	// of
	// "projects/{project_id}/configs/{config_id}/waiters/{waiter_id}",
	// Wh
	// ere `project_id` must be a valid Google Cloud project ID,
	// `config_id`
	// must be a valid RuntimeConfig object and the `waiter_id` must
	// match
	// RFC 1035 segment specification, and `len(waiter_id)` must be less
	// than
	// 64 bytes.
	// The name is assigned by the client, but will be validated on the
	// server
	// side to adhere to the format.
	// Name is immutable and cannot be changed. Required.
	Name string `json:"name,omitempty"`

	// Success: 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. Required.
	Success *EndCondition `json:"success,omitempty"`

	// Timeout: The timeout, beginning from the instant that CreateWaiter is
	// called. If
	// this timeout elapses prior to the success or failure conditions being
	// met,
	// the Waiter will fail and the `error` code will be set to
	// DEADLINE_EXCEEDED.
	// Required.
	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:"-"`
}

Waiter: A Waiter resource waits for some condition within a RuntimeConfig resource to be met. For example: each node in a distributed system startup process writes a value to a Variable resource indicating its readiness. A Waiter configured with the proper `success` condition can be used to wait until some number of nodes have checked in. Once created, a Waiter resource is immutable.

func (*Waiter) MarshalJSON

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

type WatchVariableRequest

type WatchVariableRequest struct {
	// NewerThan: If backend has a variable that has a newer value than this
	// timestamp, then
	// request will return immediately with current value.
	// If not specified or variable has an older timestamp, will wait for
	// the new
	// value.
	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:"-"`
}

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