| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="networksecurity_v1.html">Network Security API</a> . <a href="networksecurity_v1.projects.html">projects</a> . <a href="networksecurity_v1.projects.locations.html">locations</a> . <a href="networksecurity_v1.projects.locations.interceptEndpointGroups.html">interceptEndpointGroups</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, interceptEndpointGroupId=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates an endpoint group in a given project and location. See https://google.aip.dev/133.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes an endpoint group. See https://google.aip.dev/135.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a specific endpoint group. See https://google.aip.dev/131.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists endpoint groups in a given project and location. See https://google.aip.dev/132.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an endpoint group. See https://google.aip.dev/134.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, interceptEndpointGroupId=None, requestId=None, x__xgafv=None)</code> |
| <pre>Creates an endpoint group in a given project and location. See https://google.aip.dev/133. |
| |
| Args: |
| parent: string, Required. The parent resource where this endpoint group will be created. Format: projects/{project}/locations/{location} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # An endpoint group is a consumer frontend for a deployment group (backend). In order to configure intercept for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A firewall rule that references the security profile (group). |
| "associations": [ # Output only. List of associations to this endpoint group. |
| { # The endpoint group's view of a connected association. |
| "name": "A String", # Output only. The connected association's resource name, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-ega`. See https://google.aip.dev/124. |
| "network": "A String", # Output only. The associated network, for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124. |
| "state": "A String", # Output only. Most recent known state of the association. |
| }, |
| ], |
| "connectedDeploymentGroup": { # The endpoint group's view of a connected deployment group. # Output only. Details about the connected deployment group to this endpoint group. |
| "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", # Output only. The connected deployment group's resource name, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. 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 endpoint group. Used as additional context for the endpoint group. |
| "interceptDeploymentGroup": "A String", # Required. Immutable. The deployment group that this endpoint group is connected to, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/124. |
| "labels": { # Optional. Labels are key/value pairs that help to organize and filter resources. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details. |
| "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 association to the group). See https://google.aip.dev/128. |
| "state": "A String", # Output only. The current state of the endpoint 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. |
| } |
| |
| interceptEndpointGroupId: string, Required. The ID to use for the endpoint group, which will become the final component of the endpoint 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. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code> |
| <pre>Deletes an endpoint group. See https://google.aip.dev/135. |
| |
| Args: |
| name: string, Required. The endpoint 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. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets a specific endpoint group. See https://google.aip.dev/131. |
| |
| Args: |
| name: string, Required. The name of the endpoint group to retrieve. Format: projects/{project}/locations/{location}/interceptEndpointGroups/{intercept_endpoint_group} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An endpoint group is a consumer frontend for a deployment group (backend). In order to configure intercept for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A firewall rule that references the security profile (group). |
| "associations": [ # Output only. List of associations to this endpoint group. |
| { # The endpoint group's view of a connected association. |
| "name": "A String", # Output only. The connected association's resource name, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-ega`. See https://google.aip.dev/124. |
| "network": "A String", # Output only. The associated network, for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124. |
| "state": "A String", # Output only. Most recent known state of the association. |
| }, |
| ], |
| "connectedDeploymentGroup": { # The endpoint group's view of a connected deployment group. # Output only. Details about the connected deployment group to this endpoint group. |
| "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", # Output only. The connected deployment group's resource name, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. 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 endpoint group. Used as additional context for the endpoint group. |
| "interceptDeploymentGroup": "A String", # Required. Immutable. The deployment group that this endpoint group is connected to, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/124. |
| "labels": { # Optional. Labels are key/value pairs that help to organize and filter resources. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details. |
| "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 association to the group). See https://google.aip.dev/128. |
| "state": "A String", # Output only. The current state of the endpoint 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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists endpoint groups in a given project and location. See https://google.aip.dev/132. |
| |
| Args: |
| parent: string, Required. The parent, which owns this collection of endpoint 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 `ListInterceptEndpointGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInterceptEndpointGroups` 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 ListInterceptEndpointGroups. |
| "interceptEndpointGroups": [ # The endpoint groups from the specified parent. |
| { # An endpoint group is a consumer frontend for a deployment group (backend). In order to configure intercept for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A firewall rule that references the security profile (group). |
| "associations": [ # Output only. List of associations to this endpoint group. |
| { # The endpoint group's view of a connected association. |
| "name": "A String", # Output only. The connected association's resource name, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-ega`. See https://google.aip.dev/124. |
| "network": "A String", # Output only. The associated network, for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124. |
| "state": "A String", # Output only. Most recent known state of the association. |
| }, |
| ], |
| "connectedDeploymentGroup": { # The endpoint group's view of a connected deployment group. # Output only. Details about the connected deployment group to this endpoint group. |
| "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", # Output only. The connected deployment group's resource name, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. 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 endpoint group. Used as additional context for the endpoint group. |
| "interceptDeploymentGroup": "A String", # Required. Immutable. The deployment group that this endpoint group is connected to, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/124. |
| "labels": { # Optional. Labels are key/value pairs that help to organize and filter resources. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details. |
| "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 association to the group). See https://google.aip.dev/128. |
| "state": "A String", # Output only. The current state of the endpoint 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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates an endpoint group. See https://google.aip.dev/134. |
| |
| Args: |
| name: string, Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # An endpoint group is a consumer frontend for a deployment group (backend). In order to configure intercept for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A firewall rule that references the security profile (group). |
| "associations": [ # Output only. List of associations to this endpoint group. |
| { # The endpoint group's view of a connected association. |
| "name": "A String", # Output only. The connected association's resource name, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-ega`. See https://google.aip.dev/124. |
| "network": "A String", # Output only. The associated network, for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124. |
| "state": "A String", # Output only. Most recent known state of the association. |
| }, |
| ], |
| "connectedDeploymentGroup": { # The endpoint group's view of a connected deployment group. # Output only. Details about the connected deployment group to this endpoint group. |
| "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", # Output only. The connected deployment group's resource name, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. 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 endpoint group. Used as additional context for the endpoint group. |
| "interceptDeploymentGroup": "A String", # Required. Immutable. The deployment group that this endpoint group is connected to, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/124. |
| "labels": { # Optional. Labels are key/value pairs that help to organize and filter resources. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details. |
| "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 association to the group). See https://google.aip.dev/128. |
| "state": "A String", # Output only. The current state of the endpoint 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 endpoint group (e.g. `description`; *not* `intercept_endpoint_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. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
