Google Cloud RuntimeConfig API . projects . configs

Instance Methods

operations()

Returns the operations Resource.

variables()

Returns the variables Resource.

waiters()

Returns the waiters Resource.

create(parent=None, body, x__xgafv=None)

CreateConfig creates a new config resource object.

delete(name=None, x__xgafv=None)

Deletes the config object.

get(name, x__xgafv=None)

Gets the config resource object.

list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)

Lists all the config objects within project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(name=None, body, x__xgafv=None)

Updates the config resource object.

Method Details

create(parent=None, body, x__xgafv=None)
CreateConfig creates a new config resource object.
The configuration name must be unique within project.

Args:
  parent: string, The cloud project to which configuration belongs.
Required. Must be a valid GCP project. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # RuntimeConfig is the primary resource in the Configuration service.
      # It consists of metadata and a hierarchy of variables.
    "description": "A String", # Description of the configuration object.
        # `len(description)` must be less than 256.
    "name": "A String", # 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.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # RuntimeConfig is the primary resource in the Configuration service.
        # It consists of metadata and a hierarchy of variables.
      "description": "A String", # Description of the configuration object.
          # `len(description)` must be less than 256.
      "name": "A String", # 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.
    }
delete(name=None, x__xgafv=None)
Deletes the config object.

Args:
  name: string, The configuration resource object to delete.
Required. Must be a valid GCP project. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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 `{}`.
  }
get(name, x__xgafv=None)
Gets the config resource object.

Args:
  name: string, The name of the RuntimeConfig resource object to retrieve. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # RuntimeConfig is the primary resource in the Configuration service.
        # It consists of metadata and a hierarchy of variables.
      "description": "A String", # Description of the configuration object.
          # `len(description)` must be less than 256.
      "name": "A String", # 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.
    }
list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)
Lists all the config objects within project.

Args:
  parent: string, The cloud project, whose configuration resources we want to list.
Required. Must be a valid GCP project. (required)
  pageToken: string, The token for pagination.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, List pagination support.
The size of the page to return. We may return fewer elements.

Returns:
  An object of the form:

    { # Response for the `ListConfigs()` method.
      # Order of returned configuration objects is arbitrary.
    "nextPageToken": "A String", # Pagination support.
    "configs": [ # Found configurations in the project.
      { # RuntimeConfig is the primary resource in the Configuration service.
            # It consists of metadata and a hierarchy of variables.
          "description": "A String", # Description of the configuration object.
              # `len(description)` must be less than 256.
          "name": "A String", # 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.
        },
    ],
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
update(name=None, body, x__xgafv=None)
Updates the config resource object.
RuntimeConfig object must already exist.

Args:
  name: string, The name of the config resource to update.
Required. Must be a valid config resource. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # RuntimeConfig is the primary resource in the Configuration service.
      # It consists of metadata and a hierarchy of variables.
    "description": "A String", # Description of the configuration object.
        # `len(description)` must be less than 256.
    "name": "A String", # 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.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # RuntimeConfig is the primary resource in the Configuration service.
        # It consists of metadata and a hierarchy of variables.
      "description": "A String", # Description of the configuration object.
          # `len(description)` must be less than 256.
      "name": "A String", # 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.
    }