# Network Security API . projects . locations . interceptDeploymentGroups

## Instance Methods

Close httplib2 connections.

Creates a deployment group in a given project and location. See https://google.aip.dev/133.

Deletes a deployment group. See https://google.aip.dev/135.

Gets a specific deployment group. See https://google.aip.dev/131.

Lists deployment groups in a given project and location. See https://google.aip.dev/132.

Retrieves the next page of results.

Updates a deployment group. See https://google.aip.dev/134.

### Method Details

`close()`

    Close httplib2 connections.

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

    Creates a deployment group in a given project and location. See https://google.aip.dev/133.

    Args:
      parent: string, Required. The parent resource where this deployment group will be created. Format: projects/{project}/locations/{location} (required)
      body: object, The request body.
        The object takes the form of:

    { # A deployment group aggregates many zonal intercept backends (deployments) into a single global intercept service. Consumers can connect this service using an endpoint group.
      "connectedEndpointGroups": [ # Output only. The list of endpoint groups that are connected to this resource.
        { # An endpoint group connected to this deployment group.
          "name": "A String", # Output only. The connected endpoint group's resource name, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/124.
        },
      ],
      "createTime": "A String", # Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
      "description": "A String", # Optional. User-provided description of the deployment group. Used as additional context for the deployment group.
      "labels": { # Optional. Labels are key/value pairs that help to organize and filter resources.
        "a_key": "A String",
      },
      "locations": [ # Output only. The list of locations where the deployment group is present.
        { # Details about intercept in a specific cloud location.
          "location": "A String", # Output only. The cloud location, e.g. "us-central1-a" or "asia-south1".
          "state": "A String", # Output only. The current state of the association in this location.
        },
      ],
      "name": "A String", # Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details.
      "nestedDeployments": [ # Output only. The list of Intercept Deployments that belong to this group.
        { # A deployment belonging to this deployment group.
          "name": "A String", # Output only. The name of the Intercept Deployment, in the format: `projects/{project}/locations/{location}/interceptDeployments/{intercept_deployment}`.
          "state": "A String", # Output only. Most recent known state of the deployment.
        },
      ],
      "network": "A String", # Required. Immutable. The network that will be used for all child deployments, for example: `projects/{project}/global/networks/{network}`. See https://google.aip.dev/124.
      "reconciling": True or False, # Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new deployment to the group) See https://google.aip.dev/128.
      "state": "A String", # Output only. The current state of the deployment group. See https://google.aip.dev/216.
      "updateTime": "A String", # Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
    }

      interceptDeploymentGroupId: string, Required. The ID to use for the new deployment group, which will become the final component of the deployment group's resource name.
      requestId: string, Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.
      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 deployment group. See https://google.aip.dev/135.

    Args:
      name: string, Required. The deployment group to delete. (required)
      requestId: string, Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.
      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 a specific deployment group. See https://google.aip.dev/131.

    Args:
      name: string, Required. The name of the deployment group to retrieve. Format: projects/{project}/locations/{location}/interceptDeploymentGroups/{intercept_deployment_group} (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A deployment group aggregates many zonal intercept backends (deployments) into a single global intercept service. Consumers can connect this service using an endpoint group.
      "connectedEndpointGroups": [ # Output only. The list of endpoint groups that are connected to this resource.
        { # An endpoint group connected to this deployment group.
          "name": "A String", # Output only. The connected endpoint group's resource name, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/124.
        },
      ],
      "createTime": "A String", # Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
      "description": "A String", # Optional. User-provided description of the deployment group. Used as additional context for the deployment group.
      "labels": { # Optional. Labels are key/value pairs that help to organize and filter resources.
        "a_key": "A String",
      },
      "locations": [ # Output only. The list of locations where the deployment group is present.
        { # Details about intercept in a specific cloud location.
          "location": "A String", # Output only. The cloud location, e.g. "us-central1-a" or "asia-south1".
          "state": "A String", # Output only. The current state of the association in this location.
        },
      ],
      "name": "A String", # Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details.
      "nestedDeployments": [ # Output only. The list of Intercept Deployments that belong to this group.
        { # A deployment belonging to this deployment group.
          "name": "A String", # Output only. The name of the Intercept Deployment, in the format: `projects/{project}/locations/{location}/interceptDeployments/{intercept_deployment}`.
          "state": "A String", # Output only. Most recent known state of the deployment.
        },
      ],
      "network": "A String", # Required. Immutable. The network that will be used for all child deployments, for example: `projects/{project}/global/networks/{network}`. See https://google.aip.dev/124.
      "reconciling": True or False, # Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new deployment to the group) See https://google.aip.dev/128.
      "state": "A String", # Output only. The current state of the deployment group. See https://google.aip.dev/216.
      "updateTime": "A String", # Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
    }

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

    Lists deployment groups in a given project and location. See https://google.aip.dev/132.

    Args:
      parent: string, Required. The parent, which owns this collection of deployment groups. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details. (required)
      filter: string, Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.
      orderBy: string, Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.
      pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.
      pageToken: string, Optional. A page token, received from a previous `ListInterceptDeploymentGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInterceptDeploymentGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for ListInterceptDeploymentGroups.
      "interceptDeploymentGroups": [ # The deployment groups from the specified parent.
        { # A deployment group aggregates many zonal intercept backends (deployments) into a single global intercept service. Consumers can connect this service using an endpoint group.
          "connectedEndpointGroups": [ # Output only. The list of endpoint groups that are connected to this resource.
            { # An endpoint group connected to this deployment group.
              "name": "A String", # Output only. The connected endpoint group's resource name, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/124.
            },
          ],
          "createTime": "A String", # Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
          "description": "A String", # Optional. User-provided description of the deployment group. Used as additional context for the deployment group.
          "labels": { # Optional. Labels are key/value pairs that help to organize and filter resources.
            "a_key": "A String",
          },
          "locations": [ # Output only. The list of locations where the deployment group is present.
            { # Details about intercept in a specific cloud location.
              "location": "A String", # Output only. The cloud location, e.g. "us-central1-a" or "asia-south1".
              "state": "A String", # Output only. The current state of the association in this location.
            },
          ],
          "name": "A String", # Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details.
          "nestedDeployments": [ # Output only. The list of Intercept Deployments that belong to this group.
            { # A deployment belonging to this deployment group.
              "name": "A String", # Output only. The name of the Intercept Deployment, in the format: `projects/{project}/locations/{location}/interceptDeployments/{intercept_deployment}`.
              "state": "A String", # Output only. Most recent known state of the deployment.
            },
          ],
          "network": "A String", # Required. Immutable. The network that will be used for all child deployments, for example: `projects/{project}/global/networks/{network}`. See https://google.aip.dev/124.
          "reconciling": True or False, # Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new deployment to the group) See https://google.aip.dev/128.
          "state": "A String", # Output only. The current state of the deployment group. See https://google.aip.dev/216.
          "updateTime": "A String", # Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
        },
      ],
      "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. See https://google.aip.dev/158 for more details.
    }

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

    Updates a deployment group. See https://google.aip.dev/134.

    Args:
      name: string, Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details. (required)
      body: object, The request body.
        The object takes the form of:

    { # A deployment group aggregates many zonal intercept backends (deployments) into a single global intercept service. Consumers can connect this service using an endpoint group.
      "connectedEndpointGroups": [ # Output only. The list of endpoint groups that are connected to this resource.
        { # An endpoint group connected to this deployment group.
          "name": "A String", # Output only. The connected endpoint group's resource name, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/124.
        },
      ],
      "createTime": "A String", # Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
      "description": "A String", # Optional. User-provided description of the deployment group. Used as additional context for the deployment group.
      "labels": { # Optional. Labels are key/value pairs that help to organize and filter resources.
        "a_key": "A String",
      },
      "locations": [ # Output only. The list of locations where the deployment group is present.
        { # Details about intercept in a specific cloud location.
          "location": "A String", # Output only. The cloud location, e.g. "us-central1-a" or "asia-south1".
          "state": "A String", # Output only. The current state of the association in this location.
        },
      ],
      "name": "A String", # Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details.
      "nestedDeployments": [ # Output only. The list of Intercept Deployments that belong to this group.
        { # A deployment belonging to this deployment group.
          "name": "A String", # Output only. The name of the Intercept Deployment, in the format: `projects/{project}/locations/{location}/interceptDeployments/{intercept_deployment}`.
          "state": "A String", # Output only. Most recent known state of the deployment.
        },
      ],
      "network": "A String", # Required. Immutable. The network that will be used for all child deployments, for example: `projects/{project}/global/networks/{network}`. See https://google.aip.dev/124.
      "reconciling": True or False, # Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new deployment to the group) See https://google.aip.dev/128.
      "state": "A String", # Output only. The current state of the deployment group. See https://google.aip.dev/216.
      "updateTime": "A String", # Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
    }

      requestId: string, Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.
      updateMask: string, Optional. The list of fields to update. Fields are specified relative to the deployment group (e.g. `description`; *not* `intercept_deployment_group.description`). See https://google.aip.dev/161 for more details.
      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.
      },
    }