Show / Hide Table of Contents

Class ProjectsResource.ConfigsResource.VariablesResource

The "variables" collection of methods.

Inheritance
object
ProjectsResource.ConfigsResource.VariablesResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudRuntimeConfig.v1beta1
Assembly: Google.Apis.CloudRuntimeConfig.v1beta1.dll
Syntax
public class ProjectsResource.ConfigsResource.VariablesResource

Constructors

VariablesResource(IClientService)

Constructs a new resource.

Declaration
public VariablesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Create(Variable, string)

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 documentation.

Declaration
public virtual ProjectsResource.ConfigsResource.VariablesResource.CreateRequest Create(Variable body, string parent)
Parameters
Type Name Description
Variable body

The body of the request.

string parent

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

Returns
Type Description
ProjectsResource.ConfigsResource.VariablesResource.CreateRequest

Delete(string)

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.

Declaration
public virtual ProjectsResource.ConfigsResource.VariablesResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
ProjectsResource.ConfigsResource.VariablesResource.DeleteRequest

Get(string)

Gets information about a single variable.

Declaration
public virtual ProjectsResource.ConfigsResource.VariablesResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
ProjectsResource.ConfigsResource.VariablesResource.GetRequest

List(string)

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

Declaration
public virtual ProjectsResource.ConfigsResource.VariablesResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

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

Returns
Type Description
ProjectsResource.ConfigsResource.VariablesResource.ListRequest

TestIamPermissions(TestIamPermissionsRequest, string)

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

Declaration
public virtual ProjectsResource.ConfigsResource.VariablesResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.ConfigsResource.VariablesResource.TestIamPermissionsRequest

Update(Variable, string)

Updates an existing variable with a new value.

Declaration
public virtual ProjectsResource.ConfigsResource.VariablesResource.UpdateRequest Update(Variable body, string name)
Parameters
Type Name Description
Variable body

The body of the request.

string name

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

Returns
Type Description
ProjectsResource.ConfigsResource.VariablesResource.UpdateRequest

Watch(WatchVariableRequest, string)

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 documentation.

Declaration
public virtual ProjectsResource.ConfigsResource.VariablesResource.WatchRequest Watch(WatchVariableRequest body, string name)
Parameters
Type Name Description
WatchVariableRequest body

The body of the request.

string name

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

Returns
Type Description
ProjectsResource.ConfigsResource.VariablesResource.WatchRequest
In this article
Back to top Generated by DocFX