# Compute Engine API . packetMirrorings

## Instance Methods

Retrieves an aggregated list of packetMirrorings.

Retrieves the next page of results.

Deletes the specified PacketMirroring resource.

Returns the specified PacketMirroring resource.

Creates a PacketMirroring resource in the specified project and region using the data included in the request.

Retrieves a list of PacketMirroring resources available to the specified project and region.

Retrieves the next page of results.

Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Returns permissions that a caller has on the specified resource.

### Method Details

`aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)`

    Retrieves an aggregated list of packetMirrorings.

    Args:
      project: string, Project ID for this request. (required)
      filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

    For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

    You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

    To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
      includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
      maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
      orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

    You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

    Currently, only sorting by `name` or `creationTimestamp desc` is supported.
      pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

    Returns:
      An object of the form:

        { # Contains a list of packetMirrorings.
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "items": { # A list of PacketMirroring resources.
          "a_key": { # Name of the scope containing this set of packetMirrorings.
            "packetMirrorings": [ # A list of packetMirrorings contained in this scope.
              { # Represents a Packet Mirroring resource.
                  #
                  # Packet Mirroring clones the traffic of specified instances in your Virtual Private Cloud (VPC) network and forwards it to a collector destination, such as an instance group of an internal TCP/UDP load balancer, for analysis or examination. For more information about setting up Packet Mirroring, see Using Packet Mirroring. (== resource_for {$api_version}.packetMirrorings ==)
                "collectorIlb": { # The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.
                  "canonicalUrl": "A String", # [Output Only] Unique identifier for the forwarding rule; defined by the server.
                  "url": "A String", # Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic.
                },
                "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
                "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
                "enable": "A String", # Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network.
                    #
                    # The default is TRUE.
                "filter": { # Filter for mirrored traffic. If unspecified, all traffic is mirrored.
                  "IPProtocols": [ # Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.
                    "A String",
                  ],
                  "cidrRanges": [ # IP CIDR ranges that apply as filter on the source (ingress) or destination (egress) IP in the IP header. Only IPv4 is supported. If no ranges are specified, all traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.
                    "A String",
                  ],
                },
                "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
                "kind": "compute#packetMirroring", # [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.
                "mirroredResources": { # PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.
                  "instances": [ # A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring.
                      #
                      # Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring.
                      #
                      # You may specify a maximum of 50 Instances.
                    {
                      "canonicalUrl": "A String", # [Output Only] Unique identifier for the instance; defined by the server.
                      "url": "A String", # Resource URL to the virtual machine instance which is being mirrored.
                    },
                  ],
                  "subnetworks": [ # A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in the same region as this packetMirroring.
                      #
                      # You may specify a maximum of 5 subnetworks.
                    {
                      "canonicalUrl": "A String", # [Output Only] Unique identifier for the subnetwork; defined by the server.
                      "url": "A String", # Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored.
                    },
                  ],
                  "tags": [ # A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored.
                    "A String",
                  ],
                },
                "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
                "network": { # Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.
                  "canonicalUrl": "A String", # [Output Only] Unique identifier for the network; defined by the server.
                  "url": "A String", # URL of the network resource.
                },
                "priority": 42, # The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins.
                    #
                    # Default value is 1000. Valid range is 0 through 65535.
                "region": "A String", # [Output Only] URI of the region where the packetMirroring resides.
                "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
              },
            ],
            "warning": { # Informational warning which replaces the list of packetMirrorings when the list is empty.
              "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
              "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                  # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                {
                  "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                  "value": "A String", # [Output Only] A warning data value corresponding to the key.
                },
              ],
              "message": "A String", # [Output Only] A human-readable description of the warning code.
            },
          },
        },
        "kind": "compute#packetMirroringAggregatedList", # Type of resource.
        "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
        "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
        "warning": { # [Output Only] Informational warning message.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
            },
          ],
          "message": "A String", # [Output Only] A human-readable description of the warning code.
        },
      }

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

`delete(project, region, packetMirroring, requestId=None)`

    Deletes the specified PacketMirroring resource.

    Args:
      project: string, Project ID for this request. (required)
      region: string, Name of the region for this request. (required)
      packetMirroring: string, Name of the PacketMirroring resource to delete. (required)
      requestId: string, 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.

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

    Returns:
      An object of the form:

        { # Represents an Operation resource.
          #
          # Google Compute Engine has three Operation resources:
          #
          # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
          #
          # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
          #
          # Operations can be global, regional or zonal.
          # - For global operations, use the `globalOperations` resource.
          # - For regional operations, use the `regionOperations` resource.
          # - For zonal operations, use the `zonalOperations` resource.
          #
          # For more information, read  Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
        "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
        "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              "message": "A String", # [Output Only] An optional, human-readable error message.
            },
          ],
        },
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
        "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
        "name": "A String", # [Output Only] Name of the operation.
        "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
        "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
        "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
              },
            ],
            "message": "A String", # [Output Only] A human-readable description of the warning code.
          },
        ],
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
      }

`get(project, region, packetMirroring)`

    Returns the specified PacketMirroring resource.

    Args:
      project: string, Project ID for this request. (required)
      region: string, Name of the region for this request. (required)
      packetMirroring: string, Name of the PacketMirroring resource to return. (required)

    Returns:
      An object of the form:

        { # Represents a Packet Mirroring resource.
          #
          # Packet Mirroring clones the traffic of specified instances in your Virtual Private Cloud (VPC) network and forwards it to a collector destination, such as an instance group of an internal TCP/UDP load balancer, for analysis or examination. For more information about setting up Packet Mirroring, see Using Packet Mirroring. (== resource_for {$api_version}.packetMirrorings ==)
        "collectorIlb": { # The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.
          "canonicalUrl": "A String", # [Output Only] Unique identifier for the forwarding rule; defined by the server.
          "url": "A String", # Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic.
        },
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "enable": "A String", # Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network.
            #
            # The default is TRUE.
        "filter": { # Filter for mirrored traffic. If unspecified, all traffic is mirrored.
          "IPProtocols": [ # Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.
            "A String",
          ],
          "cidrRanges": [ # IP CIDR ranges that apply as filter on the source (ingress) or destination (egress) IP in the IP header. Only IPv4 is supported. If no ranges are specified, all traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.
            "A String",
          ],
        },
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "kind": "compute#packetMirroring", # [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.
        "mirroredResources": { # PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.
          "instances": [ # A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring.
              #
              # Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring.
              #
              # You may specify a maximum of 50 Instances.
            {
              "canonicalUrl": "A String", # [Output Only] Unique identifier for the instance; defined by the server.
              "url": "A String", # Resource URL to the virtual machine instance which is being mirrored.
            },
          ],
          "subnetworks": [ # A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in the same region as this packetMirroring.
              #
              # You may specify a maximum of 5 subnetworks.
            {
              "canonicalUrl": "A String", # [Output Only] Unique identifier for the subnetwork; defined by the server.
              "url": "A String", # Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored.
            },
          ],
          "tags": [ # A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored.
            "A String",
          ],
        },
        "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        "network": { # Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.
          "canonicalUrl": "A String", # [Output Only] Unique identifier for the network; defined by the server.
          "url": "A String", # URL of the network resource.
        },
        "priority": 42, # The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins.
            #
            # Default value is 1000. Valid range is 0 through 65535.
        "region": "A String", # [Output Only] URI of the region where the packetMirroring resides.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      }

`insert(project, region, body=None, requestId=None)`

    Creates a PacketMirroring resource in the specified project and region using the data included in the request.

    Args:
      project: string, Project ID for this request. (required)
      region: string, Name of the region for this request. (required)
      body: object, The request body.
        The object takes the form of:

    { # Represents a Packet Mirroring resource.
        #
        # Packet Mirroring clones the traffic of specified instances in your Virtual Private Cloud (VPC) network and forwards it to a collector destination, such as an instance group of an internal TCP/UDP load balancer, for analysis or examination. For more information about setting up Packet Mirroring, see Using Packet Mirroring. (== resource_for {$api_version}.packetMirrorings ==)
      "collectorIlb": { # The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.
        "canonicalUrl": "A String", # [Output Only] Unique identifier for the forwarding rule; defined by the server.
        "url": "A String", # Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic.
      },
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "enable": "A String", # Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network.
          #
          # The default is TRUE.
      "filter": { # Filter for mirrored traffic. If unspecified, all traffic is mirrored.
        "IPProtocols": [ # Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.
          "A String",
        ],
        "cidrRanges": [ # IP CIDR ranges that apply as filter on the source (ingress) or destination (egress) IP in the IP header. Only IPv4 is supported. If no ranges are specified, all traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.
          "A String",
        ],
      },
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "kind": "compute#packetMirroring", # [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.
      "mirroredResources": { # PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.
        "instances": [ # A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring.
            #
            # Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring.
            #
            # You may specify a maximum of 50 Instances.
          {
            "canonicalUrl": "A String", # [Output Only] Unique identifier for the instance; defined by the server.
            "url": "A String", # Resource URL to the virtual machine instance which is being mirrored.
          },
        ],
        "subnetworks": [ # A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in the same region as this packetMirroring.
            #
            # You may specify a maximum of 5 subnetworks.
          {
            "canonicalUrl": "A String", # [Output Only] Unique identifier for the subnetwork; defined by the server.
            "url": "A String", # Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored.
          },
        ],
        "tags": [ # A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored.
          "A String",
        ],
      },
      "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      "network": { # Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.
        "canonicalUrl": "A String", # [Output Only] Unique identifier for the network; defined by the server.
        "url": "A String", # URL of the network resource.
      },
      "priority": 42, # The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins.
          #
          # Default value is 1000. Valid range is 0 through 65535.
      "region": "A String", # [Output Only] URI of the region where the packetMirroring resides.
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    }

      requestId: string, 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.

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

    Returns:
      An object of the form:

        { # Represents an Operation resource.
          #
          # Google Compute Engine has three Operation resources:
          #
          # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
          #
          # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
          #
          # Operations can be global, regional or zonal.
          # - For global operations, use the `globalOperations` resource.
          # - For regional operations, use the `regionOperations` resource.
          # - For zonal operations, use the `zonalOperations` resource.
          #
          # For more information, read  Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
        "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
        "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              "message": "A String", # [Output Only] An optional, human-readable error message.
            },
          ],
        },
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
        "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
        "name": "A String", # [Output Only] Name of the operation.
        "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
        "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
        "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
              },
            ],
            "message": "A String", # [Output Only] A human-readable description of the warning code.
          },
        ],
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
      }

`list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None)`

    Retrieves a list of PacketMirroring resources available to the specified project and region.

    Args:
      project: string, Project ID for this request. (required)
      region: string, Name of the region for this request. (required)
      filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

    For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

    You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

    To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
      maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
      orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

    You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

    Currently, only sorting by `name` or `creationTimestamp desc` is supported.
      pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

    Returns:
      An object of the form:

        { # Contains a list of PacketMirroring resources.
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "items": [ # A list of PacketMirroring resources.
          { # Represents a Packet Mirroring resource.
              #
              # Packet Mirroring clones the traffic of specified instances in your Virtual Private Cloud (VPC) network and forwards it to a collector destination, such as an instance group of an internal TCP/UDP load balancer, for analysis or examination. For more information about setting up Packet Mirroring, see Using Packet Mirroring. (== resource_for {$api_version}.packetMirrorings ==)
            "collectorIlb": { # The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.
              "canonicalUrl": "A String", # [Output Only] Unique identifier for the forwarding rule; defined by the server.
              "url": "A String", # Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic.
            },
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            "enable": "A String", # Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network.
                #
                # The default is TRUE.
            "filter": { # Filter for mirrored traffic. If unspecified, all traffic is mirrored.
              "IPProtocols": [ # Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.
                "A String",
              ],
              "cidrRanges": [ # IP CIDR ranges that apply as filter on the source (ingress) or destination (egress) IP in the IP header. Only IPv4 is supported. If no ranges are specified, all traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.
                "A String",
              ],
            },
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "kind": "compute#packetMirroring", # [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.
            "mirroredResources": { # PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.
              "instances": [ # A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring.
                  #
                  # Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring.
                  #
                  # You may specify a maximum of 50 Instances.
                {
                  "canonicalUrl": "A String", # [Output Only] Unique identifier for the instance; defined by the server.
                  "url": "A String", # Resource URL to the virtual machine instance which is being mirrored.
                },
              ],
              "subnetworks": [ # A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in the same region as this packetMirroring.
                  #
                  # You may specify a maximum of 5 subnetworks.
                {
                  "canonicalUrl": "A String", # [Output Only] Unique identifier for the subnetwork; defined by the server.
                  "url": "A String", # Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored.
                },
              ],
              "tags": [ # A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored.
                "A String",
              ],
            },
            "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            "network": { # Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.
              "canonicalUrl": "A String", # [Output Only] Unique identifier for the network; defined by the server.
              "url": "A String", # URL of the network resource.
            },
            "priority": 42, # The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins.
                #
                # Default value is 1000. Valid range is 0 through 65535.
            "region": "A String", # [Output Only] URI of the region where the packetMirroring resides.
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
          },
        ],
        "kind": "compute#packetMirroringList", # [Output Only] Type of resource. Always compute#packetMirroring for packetMirrorings.
        "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
        "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
        "warning": { # [Output Only] Informational warning message.
          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
            },
          ],
          "message": "A String", # [Output Only] A human-readable description of the warning code.
        },
      }

`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(project, region, packetMirroring, body=None, requestId=None)`

    Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

    Args:
      project: string, Project ID for this request. (required)
      region: string, Name of the region for this request. (required)
      packetMirroring: string, Name of the PacketMirroring resource to patch. (required)
      body: object, The request body.
        The object takes the form of:

    { # Represents a Packet Mirroring resource.
        #
        # Packet Mirroring clones the traffic of specified instances in your Virtual Private Cloud (VPC) network and forwards it to a collector destination, such as an instance group of an internal TCP/UDP load balancer, for analysis or examination. For more information about setting up Packet Mirroring, see Using Packet Mirroring. (== resource_for {$api_version}.packetMirrorings ==)
      "collectorIlb": { # The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.
        "canonicalUrl": "A String", # [Output Only] Unique identifier for the forwarding rule; defined by the server.
        "url": "A String", # Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic.
      },
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "enable": "A String", # Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network.
          #
          # The default is TRUE.
      "filter": { # Filter for mirrored traffic. If unspecified, all traffic is mirrored.
        "IPProtocols": [ # Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.
          "A String",
        ],
        "cidrRanges": [ # IP CIDR ranges that apply as filter on the source (ingress) or destination (egress) IP in the IP header. Only IPv4 is supported. If no ranges are specified, all traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.
          "A String",
        ],
      },
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "kind": "compute#packetMirroring", # [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.
      "mirroredResources": { # PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.
        "instances": [ # A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring.
            #
            # Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring.
            #
            # You may specify a maximum of 50 Instances.
          {
            "canonicalUrl": "A String", # [Output Only] Unique identifier for the instance; defined by the server.
            "url": "A String", # Resource URL to the virtual machine instance which is being mirrored.
          },
        ],
        "subnetworks": [ # A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in the same region as this packetMirroring.
            #
            # You may specify a maximum of 5 subnetworks.
          {
            "canonicalUrl": "A String", # [Output Only] Unique identifier for the subnetwork; defined by the server.
            "url": "A String", # Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored.
          },
        ],
        "tags": [ # A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored.
          "A String",
        ],
      },
      "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      "network": { # Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.
        "canonicalUrl": "A String", # [Output Only] Unique identifier for the network; defined by the server.
        "url": "A String", # URL of the network resource.
      },
      "priority": 42, # The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins.
          #
          # Default value is 1000. Valid range is 0 through 65535.
      "region": "A String", # [Output Only] URI of the region where the packetMirroring resides.
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    }

      requestId: string, 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.

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

    Returns:
      An object of the form:

        { # Represents an Operation resource.
          #
          # Google Compute Engine has three Operation resources:
          #
          # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
          #
          # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
          #
          # Operations can be global, regional or zonal.
          # - For global operations, use the `globalOperations` resource.
          # - For regional operations, use the `regionOperations` resource.
          # - For zonal operations, use the `zonalOperations` resource.
          #
          # For more information, read  Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
        "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
        "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              "message": "A String", # [Output Only] An optional, human-readable error message.
            },
          ],
        },
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
        "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
        "name": "A String", # [Output Only] Name of the operation.
        "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
        "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
        "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
              },
            ],
            "message": "A String", # [Output Only] A human-readable description of the warning code.
          },
        ],
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
      }

`testIamPermissions(project, region, resource, body=None)`

    Returns permissions that a caller has on the specified resource.

    Args:
      project: string, Project ID for this request. (required)
      region: string, The name of the region for this request. (required)
      resource: string, Name or id of the resource for this request. (required)
      body: object, The request body.
        The object takes the form of:

    {
        "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
          "A String",
        ],
      }

    Returns:
      An object of the form:

        {
        "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
          "A String",
        ],
      }