# Apigee API . organizations . endpointAttachments

## Instance Methods

Close httplib2 connections.

Creates an endpoint attachment. **Note:** Not supported for Apigee hybrid.

Deletes an endpoint attachment.

Gets the endpoint attachment.

Lists the endpoint attachments in an organization.

Retrieves the next page of results.

### Method Details

`close()`

    Close httplib2 connections.

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

    Creates an endpoint attachment. **Note:** Not supported for Apigee hybrid.

    Args:
      parent: string, Required. Organization the endpoint attachment will be created in. (required)
      body: object, The request body.
        The object takes the form of:

    { # Apigee endpoint attachment. For more information, see [Southbound networking patterns] (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints).
      "connectionState": "A String", # Output only. State of the endpoint attachment connection to the service attachment.
      "host": "A String", # Output only. Host that can be used in either the HTTP target endpoint directly or as the host in target server.
      "location": "A String", # Required. Location of the endpoint attachment.
      "name": "A String", # Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}`
      "serviceAttachment": "A String", # Format: projects/*/regions/*/serviceAttachments/*
      "state": "A String", # Output only. State of the endpoint attachment. Values other than `ACTIVE` mean the resource is not ready to use.
    }

      endpointAttachmentId: string, ID to use for the endpoint attachment. The ID can contain lowercase letters and numbers, must start with a letter, and must be 1-20 characters in length.
      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 endpoint attachment.

    Args:
      name: string, Required. Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}` (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 the endpoint attachment.

    Args:
      name: string, Required. Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Apigee endpoint attachment. For more information, see [Southbound networking patterns] (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints).
      "connectionState": "A String", # Output only. State of the endpoint attachment connection to the service attachment.
      "host": "A String", # Output only. Host that can be used in either the HTTP target endpoint directly or as the host in target server.
      "location": "A String", # Required. Location of the endpoint attachment.
      "name": "A String", # Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}`
      "serviceAttachment": "A String", # Format: projects/*/regions/*/serviceAttachments/*
      "state": "A String", # Output only. State of the endpoint attachment. Values other than `ACTIVE` mean the resource is not ready to use.
    }

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

    Lists the endpoint attachments in an organization.

    Args:
      parent: string, Required. Name of the organization for which to list endpoint attachments. Use the following structure in your request: `organizations/{org}` (required)
      pageSize: integer, Optional. Maximum number of endpoint attachments to return. If unspecified, at most 25 attachments will be returned.
      pageToken: string, Optional. Page token, returned from a previous `ListEndpointAttachments` 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 ListEndpointAttachments method.
      "endpointAttachments": [ # Endpoint attachments in the specified organization.
        { # Apigee endpoint attachment. For more information, see [Southbound networking patterns] (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints).
          "connectionState": "A String", # Output only. State of the endpoint attachment connection to the service attachment.
          "host": "A String", # Output only. Host that can be used in either the HTTP target endpoint directly or as the host in target server.
          "location": "A String", # Required. Location of the endpoint attachment.
          "name": "A String", # Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}`
          "serviceAttachment": "A String", # Format: projects/*/regions/*/serviceAttachments/*
          "state": "A String", # Output only. State of the endpoint attachment. Values other than `ACTIVE` mean the resource is not ready to use.
        },
      ],
      "nextPageToken": "A String", # Page token that you can include in an `ListEndpointAttachments` request to retrieve the next page. If omitted, no subsequent pages exist.
    }

`list_next()`

    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.