# Network Security API . organizations . locations . firewallEndpoints

## Instance Methods

Close httplib2 connections.

Creates a new FirewallEndpoint in a given project and location.

Deletes a single Endpoint.

Gets details of a single Endpoint.

Lists FirewallEndpoints in a given project and location.

Retrieves the next page of results.

Update a single Endpoint.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, firewallEndpointId=None, requestId=None, x__xgafv=None)`

    Creates a new FirewallEndpoint in a given project and location.

    Args:
      parent: string, Required. Value for parent. (required)
      body: object, The request body.
        The object takes the form of:

    { # Message describing Endpoint object
      "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.
        "A String",
      ],
      "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.
        { # This is a subset of the FirewallEndpointAssociation message, containing fields to be used by the consumer.
          "name": "A String", # Output only. The resource name of the FirewallEndpointAssociation. Format: projects/{project}/locations/{location}/firewallEndpointAssociations/{id}
          "network": "A String", # Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}.
        },
      ],
      "billingProjectId": "A String", # Required. Project to bill on endpoint uptime usage.
      "createTime": "A String", # Output only. Create time stamp
      "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters.
      "labels": { # Optional. Labels as key value pairs
        "a_key": "A String",
      },
      "name": "A String", # Immutable. Identifier. name of resource
      "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
      "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use.
      "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use.
      "state": "A String", # Output only. Current state of the endpoint.
      "updateTime": "A String", # Output only. Update time stamp
    }

      firewallEndpointId: string, Required. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_id from the method_signature of Create RPC.
      requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
      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, successful response of the operation. 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, requestId=None, x__xgafv=None)`

    Deletes a single Endpoint.

    Args:
      name: string, Required. Name of the resource (required)
      requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
      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, successful response of the operation. 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 details of a single Endpoint.

    Args:
      name: string, Required. Name of the resource (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Message describing Endpoint object
      "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.
        "A String",
      ],
      "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.
        { # This is a subset of the FirewallEndpointAssociation message, containing fields to be used by the consumer.
          "name": "A String", # Output only. The resource name of the FirewallEndpointAssociation. Format: projects/{project}/locations/{location}/firewallEndpointAssociations/{id}
          "network": "A String", # Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}.
        },
      ],
      "billingProjectId": "A String", # Required. Project to bill on endpoint uptime usage.
      "createTime": "A String", # Output only. Create time stamp
      "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters.
      "labels": { # Optional. Labels as key value pairs
        "a_key": "A String",
      },
      "name": "A String", # Immutable. Identifier. name of resource
      "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
      "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use.
      "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use.
      "state": "A String", # Output only. Current state of the endpoint.
      "updateTime": "A String", # Output only. Update time stamp
    }

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

    Lists FirewallEndpoints in a given project and location.

    Args:
      parent: string, Required. Parent value for ListEndpointsRequest (required)
      filter: string, Optional. Filtering results
      orderBy: string, Hint for how to order the results
      pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
      pageToken: string, A token identifying a page of results the server should return.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Message for response to listing Endpoints
      "firewallEndpoints": [ # The list of Endpoint
        { # Message describing Endpoint object
          "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.
            "A String",
          ],
          "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.
            { # This is a subset of the FirewallEndpointAssociation message, containing fields to be used by the consumer.
              "name": "A String", # Output only. The resource name of the FirewallEndpointAssociation. Format: projects/{project}/locations/{location}/firewallEndpointAssociations/{id}
              "network": "A String", # Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}.
            },
          ],
          "billingProjectId": "A String", # Required. Project to bill on endpoint uptime usage.
          "createTime": "A String", # Output only. Create time stamp
          "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters.
          "labels": { # Optional. Labels as key value pairs
            "a_key": "A String",
          },
          "name": "A String", # Immutable. Identifier. name of resource
          "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
          "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use.
          "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use.
          "state": "A String", # Output only. Current state of the endpoint.
          "updateTime": "A String", # Output only. Update time stamp
        },
      ],
      "nextPageToken": "A String", # A token identifying a page of results the server should return.
      "unreachable": [ # Locations that could not be reached.
        "A String",
      ],
    }

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

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

    Update a single Endpoint.

    Args:
      name: string, Immutable. Identifier. name of resource (required)
      body: object, The request body.
        The object takes the form of:

    { # Message describing Endpoint object
      "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.
        "A String",
      ],
      "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.
        { # This is a subset of the FirewallEndpointAssociation message, containing fields to be used by the consumer.
          "name": "A String", # Output only. The resource name of the FirewallEndpointAssociation. Format: projects/{project}/locations/{location}/firewallEndpointAssociations/{id}
          "network": "A String", # Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}.
        },
      ],
      "billingProjectId": "A String", # Required. Project to bill on endpoint uptime usage.
      "createTime": "A String", # Output only. Create time stamp
      "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters.
      "labels": { # Optional. Labels as key value pairs
        "a_key": "A String",
      },
      "name": "A String", # Immutable. Identifier. name of resource
      "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
      "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use.
      "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use.
      "state": "A String", # Output only. Current state of the endpoint.
      "updateTime": "A String", # Output only. Update time stamp
    }

      requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
      updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
      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, successful response of the operation. 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.
      },
    }