close()

Close httplib2 connections.

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

Creates a new firewall endpoint in a given project and location.

Args:
parent: string, Required. The parent resource where this firewall endpoint is created. Format: `organizations/{organization}/locations/{location}` or `projects/{project}/locations/{location}`. (required)
body: object, The request body.
The object takes the form of:

{ # Message describing a firewall endpoint.
"associatedNetworks": [ # Output only. Deprecated: Use the `network` field in the `associations` message instead. List of networks that are associated with this endpoint in the local zone. This is a projection of the firewall endpoint association resources pointing at this endpoint. A network only appears in this list after traffic routing is fully configured. Format: `projects/{project}/global/networks/{name}`.
"A String",
],
"associations": [ # Output only. List of firewall endpoint association resources that are associated with this endpoint. An association only appears in this list after traffic routing is fully configured.
{ # 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 associated VPC network. Format: `projects/{project}/global/networks/{name}`.
},
],
"billingProjectId": "A String", # Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.
"createTime": "A String", # Output only. Create timestamp.
"description": "A String", # Optional. Description of the firewall endpoint. The maximum length is 2048 characters.
"endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint.
"contentCloudRegion": "A String", # Optional. The content cloud region of the endpoint.
"httpPartialResponseBlocked": True or False, # Optional. Whether to block HTTP partial responses for the endpoint. When set to `true`, the firewall blocks the resumption of HTTP file downloads. Setting this to `false` provides maximum availability, while `true` provides maximum security.
"jumboFramesEnabled": True or False, # Optional. Immutable. Indicates whether jumbo frames are enabled. The default value is `false`.
},
"labels": { # Optional. Labels as key-value pairs.
"a_key": "A String",
},
"name": "A String", # Immutable. Identifier. The name of the 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. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. Current state of the endpoint.
"updateTime": "A String", # Output only. Update timestamp.
"wildfireSettings": { # Settings for Advanced malware sandbox analysis. # Optional. Settings for Advanced malware sandbox (WildFire) analysis.
"enabled": True or False, # Optional. Indicates whether Advanced malware sandbox analysis is enabled. The default value is `false`.
"wildfireInlineCloudAnalysisSettings": { # Settings for Advanced malware sandbox inline cloud analysis. # Optional. Settings for Advanced malware sandbox inline cloud analysis.
"maxAnalysisDuration": "A String", # Optional. The timeout that a file is held while Advanced malware sandbox inline cloud analysis is performed. Valid values are from 1 to 240000 milliseconds. In canonical JSON encoding, this is represented as a string ending in `s` (for example, `"0.001s"` to `"240s"`). The default value is `30000` milliseconds (`"30s"` in JSON).
"submissionTimeoutLoggingDisabled": True or False, # Optional. Whether to disable Advanced malware sandbox submission log generation for files that time out during Advanced malware sandbox inline cloud analysis.
"timeoutAction": "A String", # Optional. The action to take when Advanced malware sandbox inline cloud analysis times out. The default value is `ALLOW`.
},
"wildfireRealtimeLookupDuration": "A String", # Optional. The duration that a file is held while the Advanced malware sandbox real-time signature cloud performs a signature lookup. Valid values are from 1 to 5000 milliseconds. In canonical JSON encoding, this is represented as a string ending in `s` (for example, `"0.001s"` to `"5s"`). The default value is `1000` milliseconds (`"1s"` in JSON).
"wildfireRealtimeLookupTimeoutAction": "A String", # Optional. The action to take on an Advanced malware sandbox real-time signature lookup timeout. The default value is `ALLOW`.
"wildfireRegion": "A String", # Optional. The region where Advanced malware sandbox analysis is performed. For a list of Palo Alto Networks supported regions, see [Advanced WildFire global cloud](https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud).
},
}

firewallEndpointId: string, Required. The ID to use for the firewall endpoint, which becomes the final component of the endpoint's resource name. This value must be 1-63 characters long, start with a lowercase letter, contain only lowercase letters, numbers, and hyphens, and cannot end with a hyphen.
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 knows to ignore the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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`).
validateOnly: boolean, Optional. If set, validates the request and previews the endpoint, but does not actually create it.
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 project endpoint.

Args:
name: string, Required. The 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 knows to ignore the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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 project endpoint.

Args:
  name: string, Required. The 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 a firewall endpoint.
  "associatedNetworks": [ # Output only. Deprecated: Use the `network` field in the `associations` message instead. List of networks that are associated with this endpoint in the local zone. This is a projection of the firewall endpoint association resources pointing at this endpoint. A network only appears in this list after traffic routing is fully configured. Format: `projects/{project}/global/networks/{name}`.
    "A String",
  ],
  "associations": [ # Output only. List of firewall endpoint association resources that are associated with this endpoint. An association only appears in this list after traffic routing is fully configured.
    { # 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 associated VPC network. Format: `projects/{project}/global/networks/{name}`.
    },
  ],
  "billingProjectId": "A String", # Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.
  "createTime": "A String", # Output only. Create timestamp.
  "description": "A String", # Optional. Description of the firewall endpoint. The maximum length is 2048 characters.
  "endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint.
    "contentCloudRegion": "A String", # Optional. The content cloud region of the endpoint.
    "httpPartialResponseBlocked": True or False, # Optional. Whether to block HTTP partial responses for the endpoint. When set to `true`, the firewall blocks the resumption of HTTP file downloads. Setting this to `false` provides maximum availability, while `true` provides maximum security.
    "jumboFramesEnabled": True or False, # Optional. Immutable. Indicates whether jumbo frames are enabled. The default value is `false`.
  },
  "labels": { # Optional. Labels as key-value pairs.
    "a_key": "A String",
  },
  "name": "A String", # Immutable. Identifier. The name of the 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. Reserved for future use.
  "satisfiesPzs": True or False, # Output only. Reserved for future use.
  "state": "A String", # Output only. Current state of the endpoint.
  "updateTime": "A String", # Output only. Update timestamp.
  "wildfireSettings": { # Settings for Advanced malware sandbox analysis. # Optional. Settings for Advanced malware sandbox (WildFire) analysis.
    "enabled": True or False, # Optional. Indicates whether Advanced malware sandbox analysis is enabled. The default value is `false`.
    "wildfireInlineCloudAnalysisSettings": { # Settings for Advanced malware sandbox inline cloud analysis. # Optional. Settings for Advanced malware sandbox inline cloud analysis.
      "maxAnalysisDuration": "A String", # Optional. The timeout that a file is held while Advanced malware sandbox inline cloud analysis is performed. Valid values are from 1 to 240000 milliseconds. In canonical JSON encoding, this is represented as a string ending in `s` (for example, `"0.001s"` to `"240s"`). The default value is `30000` milliseconds (`"30s"` in JSON).
      "submissionTimeoutLoggingDisabled": True or False, # Optional. Whether to disable Advanced malware sandbox submission log generation for files that time out during Advanced malware sandbox inline cloud analysis.
      "timeoutAction": "A String", # Optional. The action to take when Advanced malware sandbox inline cloud analysis times out. The default value is `ALLOW`.
    },
    "wildfireRealtimeLookupDuration": "A String", # Optional. The duration that a file is held while the Advanced malware sandbox real-time signature cloud performs a signature lookup. Valid values are from 1 to 5000 milliseconds. In canonical JSON encoding, this is represented as a string ending in `s` (for example, `"0.001s"` to `"5s"`). The default value is `1000` milliseconds (`"1s"` in JSON).
    "wildfireRealtimeLookupTimeoutAction": "A String", # Optional. The action to take on an Advanced malware sandbox real-time signature lookup timeout. The default value is `ALLOW`.
    "wildfireRegion": "A String", # Optional. The region where Advanced malware sandbox analysis is performed. For a list of Palo Alto Networks supported regions, see [Advanced WildFire global cloud](https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud).
  },
}

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

Lists firewall endpoints in a given project and location.

Args:
parent: string, Required. The parent resource from which the firewall endpoints are listed. Format: `organizations/{organization}/locations/{location}` or `projects/{project}/locations/{location}`. (required)
filter: string, Optional. Filtering results.
orderBy: string, Optional. Hint for how to order the results.
pageSize: integer, Optional. Requested page size. The server might return fewer items than requested. The maximum value is 1000; values above 1000 are coerced to 1000. If unspecified, the server picks an appropriate default.
pageToken: string, A page token, received from a previous `ListFirewallEndpoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirewallEndpoints` must match the call that provided the page token.
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 endpoints.
{ # Message describing a firewall endpoint.
"associatedNetworks": [ # Output only. Deprecated: Use the `network` field in the `associations` message instead. List of networks that are associated with this endpoint in the local zone. This is a projection of the firewall endpoint association resources pointing at this endpoint. A network only appears in this list after traffic routing is fully configured. Format: `projects/{project}/global/networks/{name}`.
"A String",
],
"associations": [ # Output only. List of firewall endpoint association resources that are associated with this endpoint. An association only appears in this list after traffic routing is fully configured.
{ # 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 associated VPC network. Format: `projects/{project}/global/networks/{name}`.
},
],
"billingProjectId": "A String", # Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.
"createTime": "A String", # Output only. Create timestamp.
"description": "A String", # Optional. Description of the firewall endpoint. The maximum length is 2048 characters.
"endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint.
"contentCloudRegion": "A String", # Optional. The content cloud region of the endpoint.
"httpPartialResponseBlocked": True or False, # Optional. Whether to block HTTP partial responses for the endpoint. When set to `true`, the firewall blocks the resumption of HTTP file downloads. Setting this to `false` provides maximum availability, while `true` provides maximum security.
"jumboFramesEnabled": True or False, # Optional. Immutable. Indicates whether jumbo frames are enabled. The default value is `false`.
},
"labels": { # Optional. Labels as key-value pairs.
"a_key": "A String",
},
"name": "A String", # Immutable. Identifier. The name of the 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. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. Current state of the endpoint.
"updateTime": "A String", # Output only. Update timestamp.
"wildfireSettings": { # Settings for Advanced malware sandbox analysis. # Optional. Settings for Advanced malware sandbox (WildFire) analysis.
"enabled": True or False, # Optional. Indicates whether Advanced malware sandbox analysis is enabled. The default value is `false`.
"wildfireInlineCloudAnalysisSettings": { # Settings for Advanced malware sandbox inline cloud analysis. # Optional. Settings for Advanced malware sandbox inline cloud analysis.
"maxAnalysisDuration": "A String", # Optional. The timeout that a file is held while Advanced malware sandbox inline cloud analysis is performed. Valid values are from 1 to 240000 milliseconds. In canonical JSON encoding, this is represented as a string ending in `s` (for example, `"0.001s"` to `"240s"`). The default value is `30000` milliseconds (`"30s"` in JSON).
"submissionTimeoutLoggingDisabled": True or False, # Optional. Whether to disable Advanced malware sandbox submission log generation for files that time out during Advanced malware sandbox inline cloud analysis.
"timeoutAction": "A String", # Optional. The action to take when Advanced malware sandbox inline cloud analysis times out. The default value is `ALLOW`.
},
"wildfireRealtimeLookupDuration": "A String", # Optional. The duration that a file is held while the Advanced malware sandbox real-time signature cloud performs a signature lookup. Valid values are from 1 to 5000 milliseconds. In canonical JSON encoding, this is represented as a string ending in `s` (for example, `"0.001s"` to `"5s"`). The default value is `1000` milliseconds (`"1s"` in JSON).
"wildfireRealtimeLookupTimeoutAction": "A String", # Optional. The action to take on an Advanced malware sandbox real-time signature lookup timeout. The default value is `ALLOW`.
"wildfireRegion": "A String", # Optional. The region where Advanced malware sandbox analysis is performed. For a list of Palo Alto Networks supported regions, see [Advanced WildFire global cloud](https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud).
},
},
],
"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.
"unreachable": [ # Locations that could not be reached. The list of unreachable locations might expand in the future.
"A String",
],
}

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, requestId=None, updateMask=None, x__xgafv=None)

Updates a single project endpoint.

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

{ # Message describing a firewall endpoint.
"associatedNetworks": [ # Output only. Deprecated: Use the `network` field in the `associations` message instead. List of networks that are associated with this endpoint in the local zone. This is a projection of the firewall endpoint association resources pointing at this endpoint. A network only appears in this list after traffic routing is fully configured. Format: `projects/{project}/global/networks/{name}`.
"A String",
],
"associations": [ # Output only. List of firewall endpoint association resources that are associated with this endpoint. An association only appears in this list after traffic routing is fully configured.
{ # 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 associated VPC network. Format: `projects/{project}/global/networks/{name}`.
},
],
"billingProjectId": "A String", # Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.
"createTime": "A String", # Output only. Create timestamp.
"description": "A String", # Optional. Description of the firewall endpoint. The maximum length is 2048 characters.
"endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint.
"contentCloudRegion": "A String", # Optional. The content cloud region of the endpoint.
"httpPartialResponseBlocked": True or False, # Optional. Whether to block HTTP partial responses for the endpoint. When set to `true`, the firewall blocks the resumption of HTTP file downloads. Setting this to `false` provides maximum availability, while `true` provides maximum security.
"jumboFramesEnabled": True or False, # Optional. Immutable. Indicates whether jumbo frames are enabled. The default value is `false`.
},
"labels": { # Optional. Labels as key-value pairs.
"a_key": "A String",
},
"name": "A String", # Immutable. Identifier. The name of the 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. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. Current state of the endpoint.
"updateTime": "A String", # Output only. Update timestamp.
"wildfireSettings": { # Settings for Advanced malware sandbox analysis. # Optional. Settings for Advanced malware sandbox (WildFire) analysis.
"enabled": True or False, # Optional. Indicates whether Advanced malware sandbox analysis is enabled. The default value is `false`.
"wildfireInlineCloudAnalysisSettings": { # Settings for Advanced malware sandbox inline cloud analysis. # Optional. Settings for Advanced malware sandbox inline cloud analysis.
"maxAnalysisDuration": "A String", # Optional. The timeout that a file is held while Advanced malware sandbox inline cloud analysis is performed. Valid values are from 1 to 240000 milliseconds. In canonical JSON encoding, this is represented as a string ending in `s` (for example, `"0.001s"` to `"240s"`). The default value is `30000` milliseconds (`"30s"` in JSON).
"submissionTimeoutLoggingDisabled": True or False, # Optional. Whether to disable Advanced malware sandbox submission log generation for files that time out during Advanced malware sandbox inline cloud analysis.
"timeoutAction": "A String", # Optional. The action to take when Advanced malware sandbox inline cloud analysis times out. The default value is `ALLOW`.
},
"wildfireRealtimeLookupDuration": "A String", # Optional. The duration that a file is held while the Advanced malware sandbox real-time signature cloud performs a signature lookup. Valid values are from 1 to 5000 milliseconds. In canonical JSON encoding, this is represented as a string ending in `s` (for example, `"0.001s"` to `"5s"`). The default value is `1000` milliseconds (`"1s"` in JSON).
"wildfireRealtimeLookupTimeoutAction": "A String", # Optional. The action to take on an Advanced malware sandbox real-time signature lookup timeout. The default value is `ALLOW`.
"wildfireRegion": "A String", # Optional. The region where Advanced malware sandbox analysis is performed. For a list of Palo Alto Networks supported regions, see [Advanced WildFire global cloud](https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud).
},
}

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 knows to ignore the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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 used to specify the fields to be overwritten in the `FirewallEndpoint` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields present in the request are 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.
},
}

Network Security API . projects . locations . firewallEndpoints

Instance Methods

Method Details