close()

Close httplib2 connections.

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

Creates a new environment group.

Args:
parent: string, Required. Name of the organization in which to create the environment group in the following format: `organizations/{org}`. (required)
body: object, The request body.
The object takes the form of:

{ # EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name.
"createdAt": "A String", # Output only. The time at which the environment group was created as milliseconds since epoch.
"hostnames": [ # Required. Host names for this environment group.
"A String",
],
"lastModifiedAt": "A String", # Output only. The time at which the environment group was last updated as milliseconds since epoch.
"name": "A String", # ID of the environment group.
"state": "A String", # Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use.
}

name: string, ID of the environment group. Overrides any ID in the environment_group resource.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

delete(name, x__xgafv=None)

Deletes an environment group.

Args:
name: string, Required. Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Gets an environment group.

Args:
  name: string, Required. Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name.
  "createdAt": "A String", # Output only. The time at which the environment group was created as milliseconds since epoch.
  "hostnames": [ # Required. Host names for this environment group.
    "A String",
  ],
  "lastModifiedAt": "A String", # Output only. The time at which the environment group was last updated as milliseconds since epoch.
  "name": "A String", # ID of the environment group.
  "state": "A String", # Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use.
}

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

Lists all environment groups.

Args:
parent: string, Required. Name of the organization for which to list environment groups in the following format: `organizations/{org}`. (required)
pageSize: integer, Maximum number of environment groups to return. The page size defaults to 25.
pageToken: string, Page token, returned from a previous ListEnvironmentGroups call, that you can use to retrieve the next page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response for ListEnvironmentGroups.
"environmentGroups": [ # EnvironmentGroups in the specified organization.
{ # EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name.
"createdAt": "A String", # Output only. The time at which the environment group was created as milliseconds since epoch.
"hostnames": [ # Required. Host names for this environment group.
"A String",
],
"lastModifiedAt": "A String", # Output only. The time at which the environment group was last updated as milliseconds since epoch.
"name": "A String", # ID of the environment group.
"state": "A String", # Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use.
},
],
"nextPageToken": "A String", # Page token that you can include in a ListEnvironmentGroups request to retrieve the next page. If omitted, no subsequent pages exist.
}

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.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an environment group.

Args:
name: string, Required. Name of the environment group to update in the format: `organizations/{org}/envgroups/{envgroup}. (required)
body: object, The request body.
The object takes the form of:

{ # EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name.
"createdAt": "A String", # Output only. The time at which the environment group was created as milliseconds since epoch.
"hostnames": [ # Required. Host names for this environment group.
"A String",
],
"lastModifiedAt": "A String", # Output only. The time at which the environment group was last updated as milliseconds since epoch.
"name": "A String", # ID of the environment group.
"state": "A String", # Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use.
}

updateMask: string, List of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

Apigee API . organizations . envgroups

Instance Methods

Method Details