Network Management API . projects . locations . global_ . connectivityTests

close()

Close httplib2 connections.

create(parent, body=None, testId=None, x__xgafv=None)

Creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. If the endpoint specifications in `ConnectivityTest` are invalid (for example, containing non-existent resources in the network, or you don't have read permissions to the network configurations of listed projects), then the reachability result returns a value of `UNKNOWN`. If the endpoint specifications in `ConnectivityTest` are incomplete, the reachability result returns a value of AMBIGUOUS. For more information, see the Connectivity Test documentation.

Args:
  parent: string, Required. The parent resource of the Connectivity Test to create: `projects/{project_id}/locations/global` (required)
  body: object, The request body.
    The object takes the form of:

{ # A Connectivity Test for a network reachability analysis.
  "createTime": "A String", # Output only. The time the test was created.
  "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters.
  "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.
    "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions).
      "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name.
    },
    "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI.
    "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).
    "instance": "A String", # A Compute Engine instance URI.
    "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](https://cloud.google.com/load-balancing/docs/load-balancing-overview).
    "network": "A String", # A Compute Engine network URI.
    "networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.
    "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
    "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.
  },
  "displayName": "A String", # Output only. The display name of a Connectivity Test.
  "labels": { # Resource labels to represent user-provided metadata.
    "a_key": "A String",
  },
  "name": "A String", # Required. Unique name of the resource using the form: `projects/{project_id}/locations/global/connectivityTests/{test}`
  "probingDetails": { # Results of active probing from the last run of the test. # Output only. The probing details of this test from the latest run, present for applicable tests only. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.
    "abortCause": "A String", # The reason probing was aborted.
    "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # The source and destination endpoints derived from the test input and used for active probing.
      "destinationIp": "A String", # Destination IP address.
      "destinationNetworkUri": "A String", # URI of the network where this packet is sent to.
      "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP.
      "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP".
      "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from.
      "sourceIp": "A String", # Source IP address.
      "sourceNetworkUri": "A String", # URI of the network where this packet originates from.
      "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP.
    },
    "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). # Details about an internal failure or the cancellation of active probing.
      "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.
    },
    "probingLatency": { # Describes measured latency distribution. # Latency as measured by active probing in one direction: from the source to the destination endpoint.
      "latencyPercentiles": [ # Representative latency percentiles.
        { # Latency percentile rank and value.
          "latencyMicros": "A String", # percent-th percentile of latency observed, in microseconds. Fraction of percent/100 of samples have latency lower or equal to the value of this field.
          "percent": 42, # Percentage of samples this data point applies to.
        },
      ],
    },
    "result": "A String", # The overall result of active probing.
    "sentProbeCount": 42, # Number of probes sent.
    "successfulProbeCount": 42, # Number of probes that reached the destination.
    "verifyTime": "A String", # The time that reachability was assessed through active probing.
  },
  "protocol": "A String", # IP Protocol of the test. When not provided, "TCP" is assumed.
  "reachabilityDetails": { # Results of the configuration analysis from the last run of the test. # Output only. The reachability details of this test from the latest run. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.
    "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 details of a failure or a cancellation of reachability analysis.
      "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.
    },
    "result": "A String", # The overall result of the test's configuration analysis.
    "traces": [ # Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends.
      { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ```
        "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces.
          "destinationIp": "A String", # Destination IP address.
          "destinationNetworkUri": "A String", # URI of the network where this packet is sent to.
          "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP.
          "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP".
          "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from.
          "sourceIp": "A String", # Source IP address.
          "sourceNetworkUri": "A String", # URI of the network where this packet originates from.
          "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP.
        },
        "steps": [ # A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them.
          { # A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration.
            "abort": { # Details of the final state "abort" and associated resource. # Display information of the final state "abort" and reason.
              "cause": "A String", # Causes that the analysis is aborted.
              "resourceUri": "A String", # URI of the resource that caused the abort.
            },
            "causesDrop": True or False, # This is a step that leads to the final state Drop.
            "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance.
              "displayName": "A String", # Name of a Cloud SQL instance.
              "externalIp": "A String", # External IP address of a Cloud SQL instance.
              "internalIp": "A String", # Internal IP address of a Cloud SQL instance.
              "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if the instance does not have one.
              "region": "A String", # Region in which the Cloud SQL instance is running.
              "uri": "A String", # URI of a Cloud SQL instance.
            },
            "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason.
              "resourceUri": "A String", # URI of the resource that the packet is delivered to.
              "target": "A String", # Target type where the packet is delivered to.
            },
            "description": "A String", # A description of the step. Usually this is a summary of the state.
            "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason.
              "cause": "A String", # Cause that the packet is dropped.
              "resourceUri": "A String", # URI of the resource that caused the drop.
            },
            "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy.
              "destinationIp": "A String", # Destination IP address.
              "destinationNetworkUri": "A String", # URI of the network where this packet is sent to.
              "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP.
              "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP".
              "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from.
              "sourceIp": "A String", # Source IP address.
              "sourceNetworkUri": "A String", # URI of the network where this packet originates from.
              "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP.
            },
            "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display information of a Compute Engine firewall rule.
              "action": "A String", # Possible values: ALLOW, DENY
              "direction": "A String", # Possible values: INGRESS, EGRESS
              "displayName": "A String", # The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.
              "firewallRuleType": "A String", # The firewall rule's type.
              "networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with. This field is not applicable to hierarchical firewall policy rules.
              "policy": "A String", # The hierarchical firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules.
              "priority": 42, # The priority of the firewall rule.
              "targetServiceAccounts": [ # The target service accounts specified by the firewall rule.
                "A String",
              ],
              "targetTags": [ # The target tags defined by the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.
                "A String",
              ],
              "uri": "A String", # The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules.
            },
            "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason.
              "resourceUri": "A String", # URI of the resource that the packet is forwarded to.
              "target": "A String", # Target type where this packet is forwarded to.
            },
            "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule.
              "displayName": "A String", # Name of a Compute Engine forwarding rule.
              "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the test.
              "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the test.
              "networkUri": "A String", # Network URI. Only valid for Internal Load Balancer.
              "target": "A String", # Target type of the forwarding rule.
              "uri": "A String", # URI of a Compute Engine forwarding rule.
              "vip": "A String", # VIP of the forwarding rule.
            },
            "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master.
              "clusterNetworkUri": "A String", # URI of a GKE cluster network.
              "clusterUri": "A String", # URI of a GKE cluster.
              "externalIp": "A String", # External IP address of a GKE cluster master.
              "internalIp": "A String", # Internal IP address of a GKE cluster master.
            },
            "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance.
              "displayName": "A String", # Name of a Compute Engine instance.
              "externalIp": "A String", # External IP address of the network interface.
              "interface": "A String", # Name of the network interface of a Compute Engine instance.
              "internalIp": "A String", # Internal IP address of the network interface.
              "networkTags": [ # Network tags configured on the instance.
                "A String",
              ],
              "networkUri": "A String", # URI of a Compute Engine network.
              "serviceAccount": "A String", # Service account authorized for the instance.
              "uri": "A String", # URI of a Compute Engine instance.
            },
            "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers.
              "backendType": "A String", # Type of load balancer's backend configuration.
              "backendUri": "A String", # Backend configuration URI.
              "backends": [ # Information for the loadbalancer backends.
                { # For display only. Metadata associated with a specific load balancer backend.
                  "displayName": "A String", # Name of a Compute Engine instance or network endpoint.
                  "healthCheckAllowingFirewallRules": [ # A list of firewall rule URIs allowing probes from health check IP ranges.
                    "A String",
                  ],
                  "healthCheckBlockingFirewallRules": [ # A list of firewall rule URIs blocking probes from health check IP ranges.
                    "A String",
                  ],
                  "healthCheckFirewallState": "A String", # State of the health check firewall configuration.
                  "uri": "A String", # URI of a Compute Engine instance or network endpoint.
                },
              ],
              "healthCheckUri": "A String", # URI of the health check for the load balancer.
              "loadBalancerType": "A String", # Type of the load balancer.
            },
            "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network.
              "displayName": "A String", # Name of a Compute Engine network.
              "matchedIpRange": "A String", # The IP range that matches the test.
              "uri": "A String", # URI of a Compute Engine network.
            },
            "projectId": "A String", # Project ID that contains the configuration this step is validating.
            "route": { # For display only. Metadata associated with a Compute Engine route. # Display information of a Compute Engine route.
              "destIpRange": "A String", # Destination IP range of the route.
              "displayName": "A String", # Name of a Compute Engine route.
              "instanceTags": [ # Instance tags of the route.
                "A String",
              ],
              "networkUri": "A String", # URI of a Compute Engine network.
              "nextHop": "A String", # Next hop of the route.
              "nextHopType": "A String", # Type of next hop.
              "priority": 42, # Priority of the route.
              "routeType": "A String", # Type of route.
              "uri": "A String", # URI of a Compute Engine route. Dynamic route from cloud router does not have a URI. Advertised route from Google Cloud VPC to on-premises network also does not have a URI.
            },
            "state": "A String", # Each step is in one of the pre-defined states.
            "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway.
              "displayName": "A String", # Name of a VPN gateway.
              "ipAddress": "A String", # IP address of the VPN gateway.
              "networkUri": "A String", # URI of a Compute Engine network where the VPN gateway is configured.
              "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured.
              "uri": "A String", # URI of a VPN gateway.
              "vpnTunnelUri": "A String", # A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed.
            },
            "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel.
              "displayName": "A String", # Name of a VPN tunnel.
              "networkUri": "A String", # URI of a Compute Engine network where the VPN tunnel is configured.
              "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured.
              "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel.
              "remoteGatewayIp": "A String", # Remote VPN gateway's IP address.
              "routingType": "A String", # Type of the routing policy.
              "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel.
              "sourceGatewayIp": "A String", # Local VPN gateway's IP address.
              "uri": "A String", # URI of a VPN tunnel.
            },
          },
        ],
      },
    ],
    "verifyTime": "A String", # The time of the configuration analysis.
  },
  "relatedProjects": [ # Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.
    "A String",
  ],
  "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.
    "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions).
      "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name.
    },
    "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI.
    "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).
    "instance": "A String", # A Compute Engine instance URI.
    "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](https://cloud.google.com/load-balancing/docs/load-balancing-overview).
    "network": "A String", # A Compute Engine network URI.
    "networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.
    "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
    "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.
  },
  "updateTime": "A String", # Output only. The time the test's configuration was updated.
}

  testId: string, Required. The logical name of the Connectivity Test in your project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project
  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 response of the operation in case of success. 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, x__xgafv=None)

Deletes a specific `ConnectivityTest`.

Args:
  name: string, Required. Connectivity Test resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}` (required)
  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 response of the operation in case of success. 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 the details of a specific Connectivity Test.

Args:
  name: string, Required. `ConnectivityTest` resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Connectivity Test for a network reachability analysis.
  "createTime": "A String", # Output only. The time the test was created.
  "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters.
  "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.
    "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions).
      "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name.
    },
    "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI.
    "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).
    "instance": "A String", # A Compute Engine instance URI.
    "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](https://cloud.google.com/load-balancing/docs/load-balancing-overview).
    "network": "A String", # A Compute Engine network URI.
    "networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.
    "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
    "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.
  },
  "displayName": "A String", # Output only. The display name of a Connectivity Test.
  "labels": { # Resource labels to represent user-provided metadata.
    "a_key": "A String",
  },
  "name": "A String", # Required. Unique name of the resource using the form: `projects/{project_id}/locations/global/connectivityTests/{test}`
  "probingDetails": { # Results of active probing from the last run of the test. # Output only. The probing details of this test from the latest run, present for applicable tests only. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.
    "abortCause": "A String", # The reason probing was aborted.
    "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # The source and destination endpoints derived from the test input and used for active probing.
      "destinationIp": "A String", # Destination IP address.
      "destinationNetworkUri": "A String", # URI of the network where this packet is sent to.
      "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP.
      "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP".
      "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from.
      "sourceIp": "A String", # Source IP address.
      "sourceNetworkUri": "A String", # URI of the network where this packet originates from.
      "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP.
    },
    "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). # Details about an internal failure or the cancellation of active probing.
      "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.
    },
    "probingLatency": { # Describes measured latency distribution. # Latency as measured by active probing in one direction: from the source to the destination endpoint.
      "latencyPercentiles": [ # Representative latency percentiles.
        { # Latency percentile rank and value.
          "latencyMicros": "A String", # percent-th percentile of latency observed, in microseconds. Fraction of percent/100 of samples have latency lower or equal to the value of this field.
          "percent": 42, # Percentage of samples this data point applies to.
        },
      ],
    },
    "result": "A String", # The overall result of active probing.
    "sentProbeCount": 42, # Number of probes sent.
    "successfulProbeCount": 42, # Number of probes that reached the destination.
    "verifyTime": "A String", # The time that reachability was assessed through active probing.
  },
  "protocol": "A String", # IP Protocol of the test. When not provided, "TCP" is assumed.
  "reachabilityDetails": { # Results of the configuration analysis from the last run of the test. # Output only. The reachability details of this test from the latest run. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.
    "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 details of a failure or a cancellation of reachability analysis.
      "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.
    },
    "result": "A String", # The overall result of the test's configuration analysis.
    "traces": [ # Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends.
      { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ```
        "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces.
          "destinationIp": "A String", # Destination IP address.
          "destinationNetworkUri": "A String", # URI of the network where this packet is sent to.
          "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP.
          "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP".
          "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from.
          "sourceIp": "A String", # Source IP address.
          "sourceNetworkUri": "A String", # URI of the network where this packet originates from.
          "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP.
        },
        "steps": [ # A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them.
          { # A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration.
            "abort": { # Details of the final state "abort" and associated resource. # Display information of the final state "abort" and reason.
              "cause": "A String", # Causes that the analysis is aborted.
              "resourceUri": "A String", # URI of the resource that caused the abort.
            },
            "causesDrop": True or False, # This is a step that leads to the final state Drop.
            "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance.
              "displayName": "A String", # Name of a Cloud SQL instance.
              "externalIp": "A String", # External IP address of a Cloud SQL instance.
              "internalIp": "A String", # Internal IP address of a Cloud SQL instance.
              "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if the instance does not have one.
              "region": "A String", # Region in which the Cloud SQL instance is running.
              "uri": "A String", # URI of a Cloud SQL instance.
            },
            "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason.
              "resourceUri": "A String", # URI of the resource that the packet is delivered to.
              "target": "A String", # Target type where the packet is delivered to.
            },
            "description": "A String", # A description of the step. Usually this is a summary of the state.
            "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason.
              "cause": "A String", # Cause that the packet is dropped.
              "resourceUri": "A String", # URI of the resource that caused the drop.
            },
            "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy.
              "destinationIp": "A String", # Destination IP address.
              "destinationNetworkUri": "A String", # URI of the network where this packet is sent to.
              "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP.
              "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP".
              "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from.
              "sourceIp": "A String", # Source IP address.
              "sourceNetworkUri": "A String", # URI of the network where this packet originates from.
              "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP.
            },
            "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display information of a Compute Engine firewall rule.
              "action": "A String", # Possible values: ALLOW, DENY
              "direction": "A String", # Possible values: INGRESS, EGRESS
              "displayName": "A String", # The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.
              "firewallRuleType": "A String", # The firewall rule's type.
              "networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with. This field is not applicable to hierarchical firewall policy rules.
              "policy": "A String", # The hierarchical firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules.
              "priority": 42, # The priority of the firewall rule.
              "targetServiceAccounts": [ # The target service accounts specified by the firewall rule.
                "A String",
              ],
              "targetTags": [ # The target tags defined by the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.
                "A String",
              ],
              "uri": "A String", # The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules.
            },
            "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason.
              "resourceUri": "A String", # URI of the resource that the packet is forwarded to.
              "target": "A String", # Target type where this packet is forwarded to.
            },
            "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule.
              "displayName": "A String", # Name of a Compute Engine forwarding rule.
              "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the test.
              "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the test.
              "networkUri": "A String", # Network URI. Only valid for Internal Load Balancer.
              "target": "A String", # Target type of the forwarding rule.
              "uri": "A String", # URI of a Compute Engine forwarding rule.
              "vip": "A String", # VIP of the forwarding rule.
            },
            "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master.
              "clusterNetworkUri": "A String", # URI of a GKE cluster network.
              "clusterUri": "A String", # URI of a GKE cluster.
              "externalIp": "A String", # External IP address of a GKE cluster master.
              "internalIp": "A String", # Internal IP address of a GKE cluster master.
            },
            "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance.
              "displayName": "A String", # Name of a Compute Engine instance.
              "externalIp": "A String", # External IP address of the network interface.
              "interface": "A String", # Name of the network interface of a Compute Engine instance.
              "internalIp": "A String", # Internal IP address of the network interface.
              "networkTags": [ # Network tags configured on the instance.
                "A String",
              ],
              "networkUri": "A String", # URI of a Compute Engine network.
              "serviceAccount": "A String", # Service account authorized for the instance.
              "uri": "A String", # URI of a Compute Engine instance.
            },
            "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers.
              "backendType": "A String", # Type of load balancer's backend configuration.
              "backendUri": "A String", # Backend configuration URI.
              "backends": [ # Information for the loadbalancer backends.
                { # For display only. Metadata associated with a specific load balancer backend.
                  "displayName": "A String", # Name of a Compute Engine instance or network endpoint.
                  "healthCheckAllowingFirewallRules": [ # A list of firewall rule URIs allowing probes from health check IP ranges.
                    "A String",
                  ],
                  "healthCheckBlockingFirewallRules": [ # A list of firewall rule URIs blocking probes from health check IP ranges.
                    "A String",
                  ],
                  "healthCheckFirewallState": "A String", # State of the health check firewall configuration.
                  "uri": "A String", # URI of a Compute Engine instance or network endpoint.
                },
              ],
              "healthCheckUri": "A String", # URI of the health check for the load balancer.
              "loadBalancerType": "A String", # Type of the load balancer.
            },
            "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network.
              "displayName": "A String", # Name of a Compute Engine network.
              "matchedIpRange": "A String", # The IP range that matches the test.
              "uri": "A String", # URI of a Compute Engine network.
            },
            "projectId": "A String", # Project ID that contains the configuration this step is validating.
            "route": { # For display only. Metadata associated with a Compute Engine route. # Display information of a Compute Engine route.
              "destIpRange": "A String", # Destination IP range of the route.
              "displayName": "A String", # Name of a Compute Engine route.
              "instanceTags": [ # Instance tags of the route.
                "A String",
              ],
              "networkUri": "A String", # URI of a Compute Engine network.
              "nextHop": "A String", # Next hop of the route.
              "nextHopType": "A String", # Type of next hop.
              "priority": 42, # Priority of the route.
              "routeType": "A String", # Type of route.
              "uri": "A String", # URI of a Compute Engine route. Dynamic route from cloud router does not have a URI. Advertised route from Google Cloud VPC to on-premises network also does not have a URI.
            },
            "state": "A String", # Each step is in one of the pre-defined states.
            "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway.
              "displayName": "A String", # Name of a VPN gateway.
              "ipAddress": "A String", # IP address of the VPN gateway.
              "networkUri": "A String", # URI of a Compute Engine network where the VPN gateway is configured.
              "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured.
              "uri": "A String", # URI of a VPN gateway.
              "vpnTunnelUri": "A String", # A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed.
            },
            "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel.
              "displayName": "A String", # Name of a VPN tunnel.
              "networkUri": "A String", # URI of a Compute Engine network where the VPN tunnel is configured.
              "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured.
              "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel.
              "remoteGatewayIp": "A String", # Remote VPN gateway's IP address.
              "routingType": "A String", # Type of the routing policy.
              "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel.
              "sourceGatewayIp": "A String", # Local VPN gateway's IP address.
              "uri": "A String", # URI of a VPN tunnel.
            },
          },
        ],
      },
    ],
    "verifyTime": "A String", # The time of the configuration analysis.
  },
  "relatedProjects": [ # Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.
    "A String",
  ],
  "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.
    "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions).
      "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name.
    },
    "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI.
    "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).
    "instance": "A String", # A Compute Engine instance URI.
    "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](https://cloud.google.com/load-balancing/docs/load-balancing-overview).
    "network": "A String", # A Compute Engine network URI.
    "networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.
    "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
    "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.
  },
  "updateTime": "A String", # Output only. The time the test's configuration was updated.
}

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
      "auditLogConfigs": [ # The configuration for logging of each type of permission.
        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
            "A String",
          ],
          "logType": "A String", # The log type that this config enables.
        },
      ],
      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
    },
  ],
  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
    { # Associates `members`, or principals, with a `role`.
      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
      },
      "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
        "A String",
      ],
      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
    },
  ],
  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}

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

Lists all Connectivity Tests owned by a project.

Args:
  parent: string, Required. The parent resource of the Connectivity Tests: `projects/{project_id}/locations/global` (required)
  filter: string, Lists the `ConnectivityTests` that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form ` ` where operators: `<`, `>`, `<=`, `>=`, `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/proj-1/locations/global/connectivityTests/test-1 - Filter by labels: - Resources that have a key called `foo` labels.foo:* - Resources that have a key called `foo` whose value is `bar` labels.foo = bar
  orderBy: string, Field to use to sort the list.
  pageSize: integer, Number of `ConnectivityTests` to return.
  pageToken: string, Page token from an earlier query, as returned in `next_page_token`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the `ListConnectivityTests` method.
  "nextPageToken": "A String", # Page token to fetch the next set of Connectivity Tests.
  "resources": [ # List of Connectivity Tests.
    { # A Connectivity Test for a network reachability analysis.
      "createTime": "A String", # Output only. The time the test was created.
      "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters.
      "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.
        "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions).
          "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name.
        },
        "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI.
        "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).
        "instance": "A String", # A Compute Engine instance URI.
        "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](https://cloud.google.com/load-balancing/docs/load-balancing-overview).
        "network": "A String", # A Compute Engine network URI.
        "networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.
        "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
        "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.
      },
      "displayName": "A String", # Output only. The display name of a Connectivity Test.
      "labels": { # Resource labels to represent user-provided metadata.
        "a_key": "A String",
      },
      "name": "A String", # Required. Unique name of the resource using the form: `projects/{project_id}/locations/global/connectivityTests/{test}`
      "probingDetails": { # Results of active probing from the last run of the test. # Output only. The probing details of this test from the latest run, present for applicable tests only. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.
        "abortCause": "A String", # The reason probing was aborted.
        "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # The source and destination endpoints derived from the test input and used for active probing.
          "destinationIp": "A String", # Destination IP address.
          "destinationNetworkUri": "A String", # URI of the network where this packet is sent to.
          "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP.
          "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP".
          "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from.
          "sourceIp": "A String", # Source IP address.
          "sourceNetworkUri": "A String", # URI of the network where this packet originates from.
          "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP.
        },
        "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). # Details about an internal failure or the cancellation of active probing.
          "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.
        },
        "probingLatency": { # Describes measured latency distribution. # Latency as measured by active probing in one direction: from the source to the destination endpoint.
          "latencyPercentiles": [ # Representative latency percentiles.
            { # Latency percentile rank and value.
              "latencyMicros": "A String", # percent-th percentile of latency observed, in microseconds. Fraction of percent/100 of samples have latency lower or equal to the value of this field.
              "percent": 42, # Percentage of samples this data point applies to.
            },
          ],
        },
        "result": "A String", # The overall result of active probing.
        "sentProbeCount": 42, # Number of probes sent.
        "successfulProbeCount": 42, # Number of probes that reached the destination.
        "verifyTime": "A String", # The time that reachability was assessed through active probing.
      },
      "protocol": "A String", # IP Protocol of the test. When not provided, "TCP" is assumed.
      "reachabilityDetails": { # Results of the configuration analysis from the last run of the test. # Output only. The reachability details of this test from the latest run. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.
        "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 details of a failure or a cancellation of reachability analysis.
          "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.
        },
        "result": "A String", # The overall result of the test's configuration analysis.
        "traces": [ # Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends.
          { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ```
            "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces.
              "destinationIp": "A String", # Destination IP address.
              "destinationNetworkUri": "A String", # URI of the network where this packet is sent to.
              "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP.
              "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP".
              "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from.
              "sourceIp": "A String", # Source IP address.
              "sourceNetworkUri": "A String", # URI of the network where this packet originates from.
              "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP.
            },
            "steps": [ # A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them.
              { # A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration.
                "abort": { # Details of the final state "abort" and associated resource. # Display information of the final state "abort" and reason.
                  "cause": "A String", # Causes that the analysis is aborted.
                  "resourceUri": "A String", # URI of the resource that caused the abort.
                },
                "causesDrop": True or False, # This is a step that leads to the final state Drop.
                "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance.
                  "displayName": "A String", # Name of a Cloud SQL instance.
                  "externalIp": "A String", # External IP address of a Cloud SQL instance.
                  "internalIp": "A String", # Internal IP address of a Cloud SQL instance.
                  "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if the instance does not have one.
                  "region": "A String", # Region in which the Cloud SQL instance is running.
                  "uri": "A String", # URI of a Cloud SQL instance.
                },
                "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason.
                  "resourceUri": "A String", # URI of the resource that the packet is delivered to.
                  "target": "A String", # Target type where the packet is delivered to.
                },
                "description": "A String", # A description of the step. Usually this is a summary of the state.
                "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason.
                  "cause": "A String", # Cause that the packet is dropped.
                  "resourceUri": "A String", # URI of the resource that caused the drop.
                },
                "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy.
                  "destinationIp": "A String", # Destination IP address.
                  "destinationNetworkUri": "A String", # URI of the network where this packet is sent to.
                  "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP.
                  "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP".
                  "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from.
                  "sourceIp": "A String", # Source IP address.
                  "sourceNetworkUri": "A String", # URI of the network where this packet originates from.
                  "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP.
                },
                "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display information of a Compute Engine firewall rule.
                  "action": "A String", # Possible values: ALLOW, DENY
                  "direction": "A String", # Possible values: INGRESS, EGRESS
                  "displayName": "A String", # The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.
                  "firewallRuleType": "A String", # The firewall rule's type.
                  "networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with. This field is not applicable to hierarchical firewall policy rules.
                  "policy": "A String", # The hierarchical firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules.
                  "priority": 42, # The priority of the firewall rule.
                  "targetServiceAccounts": [ # The target service accounts specified by the firewall rule.
                    "A String",
                  ],
                  "targetTags": [ # The target tags defined by the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.
                    "A String",
                  ],
                  "uri": "A String", # The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules.
                },
                "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason.
                  "resourceUri": "A String", # URI of the resource that the packet is forwarded to.
                  "target": "A String", # Target type where this packet is forwarded to.
                },
                "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule.
                  "displayName": "A String", # Name of a Compute Engine forwarding rule.
                  "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the test.
                  "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the test.
                  "networkUri": "A String", # Network URI. Only valid for Internal Load Balancer.
                  "target": "A String", # Target type of the forwarding rule.
                  "uri": "A String", # URI of a Compute Engine forwarding rule.
                  "vip": "A String", # VIP of the forwarding rule.
                },
                "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master.
                  "clusterNetworkUri": "A String", # URI of a GKE cluster network.
                  "clusterUri": "A String", # URI of a GKE cluster.
                  "externalIp": "A String", # External IP address of a GKE cluster master.
                  "internalIp": "A String", # Internal IP address of a GKE cluster master.
                },
                "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance.
                  "displayName": "A String", # Name of a Compute Engine instance.
                  "externalIp": "A String", # External IP address of the network interface.
                  "interface": "A String", # Name of the network interface of a Compute Engine instance.
                  "internalIp": "A String", # Internal IP address of the network interface.
                  "networkTags": [ # Network tags configured on the instance.
                    "A String",
                  ],
                  "networkUri": "A String", # URI of a Compute Engine network.
                  "serviceAccount": "A String", # Service account authorized for the instance.
                  "uri": "A String", # URI of a Compute Engine instance.
                },
                "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers.
                  "backendType": "A String", # Type of load balancer's backend configuration.
                  "backendUri": "A String", # Backend configuration URI.
                  "backends": [ # Information for the loadbalancer backends.
                    { # For display only. Metadata associated with a specific load balancer backend.
                      "displayName": "A String", # Name of a Compute Engine instance or network endpoint.
                      "healthCheckAllowingFirewallRules": [ # A list of firewall rule URIs allowing probes from health check IP ranges.
                        "A String",
                      ],
                      "healthCheckBlockingFirewallRules": [ # A list of firewall rule URIs blocking probes from health check IP ranges.
                        "A String",
                      ],
                      "healthCheckFirewallState": "A String", # State of the health check firewall configuration.
                      "uri": "A String", # URI of a Compute Engine instance or network endpoint.
                    },
                  ],
                  "healthCheckUri": "A String", # URI of the health check for the load balancer.
                  "loadBalancerType": "A String", # Type of the load balancer.
                },
                "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network.
                  "displayName": "A String", # Name of a Compute Engine network.
                  "matchedIpRange": "A String", # The IP range that matches the test.
                  "uri": "A String", # URI of a Compute Engine network.
                },
                "projectId": "A String", # Project ID that contains the configuration this step is validating.
                "route": { # For display only. Metadata associated with a Compute Engine route. # Display information of a Compute Engine route.
                  "destIpRange": "A String", # Destination IP range of the route.
                  "displayName": "A String", # Name of a Compute Engine route.
                  "instanceTags": [ # Instance tags of the route.
                    "A String",
                  ],
                  "networkUri": "A String", # URI of a Compute Engine network.
                  "nextHop": "A String", # Next hop of the route.
                  "nextHopType": "A String", # Type of next hop.
                  "priority": 42, # Priority of the route.
                  "routeType": "A String", # Type of route.
                  "uri": "A String", # URI of a Compute Engine route. Dynamic route from cloud router does not have a URI. Advertised route from Google Cloud VPC to on-premises network also does not have a URI.
                },
                "state": "A String", # Each step is in one of the pre-defined states.
                "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway.
                  "displayName": "A String", # Name of a VPN gateway.
                  "ipAddress": "A String", # IP address of the VPN gateway.
                  "networkUri": "A String", # URI of a Compute Engine network where the VPN gateway is configured.
                  "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured.
                  "uri": "A String", # URI of a VPN gateway.
                  "vpnTunnelUri": "A String", # A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed.
                },
                "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel.
                  "displayName": "A String", # Name of a VPN tunnel.
                  "networkUri": "A String", # URI of a Compute Engine network where the VPN tunnel is configured.
                  "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured.
                  "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel.
                  "remoteGatewayIp": "A String", # Remote VPN gateway's IP address.
                  "routingType": "A String", # Type of the routing policy.
                  "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel.
                  "sourceGatewayIp": "A String", # Local VPN gateway's IP address.
                  "uri": "A String", # URI of a VPN tunnel.
                },
              },
            ],
          },
        ],
        "verifyTime": "A String", # The time of the configuration analysis.
      },
      "relatedProjects": [ # Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.
        "A String",
      ],
      "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.
        "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions).
          "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name.
        },
        "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI.
        "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).
        "instance": "A String", # A Compute Engine instance URI.
        "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](https://cloud.google.com/load-balancing/docs/load-balancing-overview).
        "network": "A String", # A Compute Engine network URI.
        "networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.
        "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
        "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.
      },
      "updateTime": "A String", # Output only. The time the test's configuration was updated.
    },
  ],
  "unreachable": [ # Locations that could not be reached (when querying all locations with `-`).
    "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, updateMask=None, x__xgafv=None)

Updates the configuration of an existing `ConnectivityTest`. After you update a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. The Reachability state in the test resource is updated with the new result. If the endpoint specifications in `ConnectivityTest` are invalid (for example, they contain non-existent resources in the network, or the user does not have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN. If the endpoint specifications in `ConnectivityTest` are incomplete, the reachability result returns a value of `AMBIGUOUS`. See the documentation in `ConnectivityTest` for for more details.

Args:
  name: string, Required. Unique name of the resource using the form: `projects/{project_id}/locations/global/connectivityTests/{test}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A Connectivity Test for a network reachability analysis.
  "createTime": "A String", # Output only. The time the test was created.
  "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters.
  "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.
    "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions).
      "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name.
    },
    "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI.
    "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).
    "instance": "A String", # A Compute Engine instance URI.
    "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](https://cloud.google.com/load-balancing/docs/load-balancing-overview).
    "network": "A String", # A Compute Engine network URI.
    "networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.
    "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
    "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.
  },
  "displayName": "A String", # Output only. The display name of a Connectivity Test.
  "labels": { # Resource labels to represent user-provided metadata.
    "a_key": "A String",
  },
  "name": "A String", # Required. Unique name of the resource using the form: `projects/{project_id}/locations/global/connectivityTests/{test}`
  "probingDetails": { # Results of active probing from the last run of the test. # Output only. The probing details of this test from the latest run, present for applicable tests only. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.
    "abortCause": "A String", # The reason probing was aborted.
    "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # The source and destination endpoints derived from the test input and used for active probing.
      "destinationIp": "A String", # Destination IP address.
      "destinationNetworkUri": "A String", # URI of the network where this packet is sent to.
      "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP.
      "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP".
      "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from.
      "sourceIp": "A String", # Source IP address.
      "sourceNetworkUri": "A String", # URI of the network where this packet originates from.
      "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP.
    },
    "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). # Details about an internal failure or the cancellation of active probing.
      "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.
    },
    "probingLatency": { # Describes measured latency distribution. # Latency as measured by active probing in one direction: from the source to the destination endpoint.
      "latencyPercentiles": [ # Representative latency percentiles.
        { # Latency percentile rank and value.
          "latencyMicros": "A String", # percent-th percentile of latency observed, in microseconds. Fraction of percent/100 of samples have latency lower or equal to the value of this field.
          "percent": 42, # Percentage of samples this data point applies to.
        },
      ],
    },
    "result": "A String", # The overall result of active probing.
    "sentProbeCount": 42, # Number of probes sent.
    "successfulProbeCount": 42, # Number of probes that reached the destination.
    "verifyTime": "A String", # The time that reachability was assessed through active probing.
  },
  "protocol": "A String", # IP Protocol of the test. When not provided, "TCP" is assumed.
  "reachabilityDetails": { # Results of the configuration analysis from the last run of the test. # Output only. The reachability details of this test from the latest run. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.
    "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 details of a failure or a cancellation of reachability analysis.
      "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.
    },
    "result": "A String", # The overall result of the test's configuration analysis.
    "traces": [ # Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends.
      { # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ```
        "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces.
          "destinationIp": "A String", # Destination IP address.
          "destinationNetworkUri": "A String", # URI of the network where this packet is sent to.
          "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP.
          "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP".
          "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from.
          "sourceIp": "A String", # Source IP address.
          "sourceNetworkUri": "A String", # URI of the network where this packet originates from.
          "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP.
        },
        "steps": [ # A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them.
          { # A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration.
            "abort": { # Details of the final state "abort" and associated resource. # Display information of the final state "abort" and reason.
              "cause": "A String", # Causes that the analysis is aborted.
              "resourceUri": "A String", # URI of the resource that caused the abort.
            },
            "causesDrop": True or False, # This is a step that leads to the final state Drop.
            "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance.
              "displayName": "A String", # Name of a Cloud SQL instance.
              "externalIp": "A String", # External IP address of a Cloud SQL instance.
              "internalIp": "A String", # Internal IP address of a Cloud SQL instance.
              "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if the instance does not have one.
              "region": "A String", # Region in which the Cloud SQL instance is running.
              "uri": "A String", # URI of a Cloud SQL instance.
            },
            "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason.
              "resourceUri": "A String", # URI of the resource that the packet is delivered to.
              "target": "A String", # Target type where the packet is delivered to.
            },
            "description": "A String", # A description of the step. Usually this is a summary of the state.
            "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason.
              "cause": "A String", # Cause that the packet is dropped.
              "resourceUri": "A String", # URI of the resource that caused the drop.
            },
            "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy.
              "destinationIp": "A String", # Destination IP address.
              "destinationNetworkUri": "A String", # URI of the network where this packet is sent to.
              "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP.
              "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP".
              "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from.
              "sourceIp": "A String", # Source IP address.
              "sourceNetworkUri": "A String", # URI of the network where this packet originates from.
              "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP.
            },
            "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display information of a Compute Engine firewall rule.
              "action": "A String", # Possible values: ALLOW, DENY
              "direction": "A String", # Possible values: INGRESS, EGRESS
              "displayName": "A String", # The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.
              "firewallRuleType": "A String", # The firewall rule's type.
              "networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with. This field is not applicable to hierarchical firewall policy rules.
              "policy": "A String", # The hierarchical firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules.
              "priority": 42, # The priority of the firewall rule.
              "targetServiceAccounts": [ # The target service accounts specified by the firewall rule.
                "A String",
              ],
              "targetTags": [ # The target tags defined by the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.
                "A String",
              ],
              "uri": "A String", # The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules.
            },
            "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason.
              "resourceUri": "A String", # URI of the resource that the packet is forwarded to.
              "target": "A String", # Target type where this packet is forwarded to.
            },
            "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule.
              "displayName": "A String", # Name of a Compute Engine forwarding rule.
              "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the test.
              "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the test.
              "networkUri": "A String", # Network URI. Only valid for Internal Load Balancer.
              "target": "A String", # Target type of the forwarding rule.
              "uri": "A String", # URI of a Compute Engine forwarding rule.
              "vip": "A String", # VIP of the forwarding rule.
            },
            "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master.
              "clusterNetworkUri": "A String", # URI of a GKE cluster network.
              "clusterUri": "A String", # URI of a GKE cluster.
              "externalIp": "A String", # External IP address of a GKE cluster master.
              "internalIp": "A String", # Internal IP address of a GKE cluster master.
            },
            "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance.
              "displayName": "A String", # Name of a Compute Engine instance.
              "externalIp": "A String", # External IP address of the network interface.
              "interface": "A String", # Name of the network interface of a Compute Engine instance.
              "internalIp": "A String", # Internal IP address of the network interface.
              "networkTags": [ # Network tags configured on the instance.
                "A String",
              ],
              "networkUri": "A String", # URI of a Compute Engine network.
              "serviceAccount": "A String", # Service account authorized for the instance.
              "uri": "A String", # URI of a Compute Engine instance.
            },
            "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers.
              "backendType": "A String", # Type of load balancer's backend configuration.
              "backendUri": "A String", # Backend configuration URI.
              "backends": [ # Information for the loadbalancer backends.
                { # For display only. Metadata associated with a specific load balancer backend.
                  "displayName": "A String", # Name of a Compute Engine instance or network endpoint.
                  "healthCheckAllowingFirewallRules": [ # A list of firewall rule URIs allowing probes from health check IP ranges.
                    "A String",
                  ],
                  "healthCheckBlockingFirewallRules": [ # A list of firewall rule URIs blocking probes from health check IP ranges.
                    "A String",
                  ],
                  "healthCheckFirewallState": "A String", # State of the health check firewall configuration.
                  "uri": "A String", # URI of a Compute Engine instance or network endpoint.
                },
              ],
              "healthCheckUri": "A String", # URI of the health check for the load balancer.
              "loadBalancerType": "A String", # Type of the load balancer.
            },
            "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network.
              "displayName": "A String", # Name of a Compute Engine network.
              "matchedIpRange": "A String", # The IP range that matches the test.
              "uri": "A String", # URI of a Compute Engine network.
            },
            "projectId": "A String", # Project ID that contains the configuration this step is validating.
            "route": { # For display only. Metadata associated with a Compute Engine route. # Display information of a Compute Engine route.
              "destIpRange": "A String", # Destination IP range of the route.
              "displayName": "A String", # Name of a Compute Engine route.
              "instanceTags": [ # Instance tags of the route.
                "A String",
              ],
              "networkUri": "A String", # URI of a Compute Engine network.
              "nextHop": "A String", # Next hop of the route.
              "nextHopType": "A String", # Type of next hop.
              "priority": 42, # Priority of the route.
              "routeType": "A String", # Type of route.
              "uri": "A String", # URI of a Compute Engine route. Dynamic route from cloud router does not have a URI. Advertised route from Google Cloud VPC to on-premises network also does not have a URI.
            },
            "state": "A String", # Each step is in one of the pre-defined states.
            "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway.
              "displayName": "A String", # Name of a VPN gateway.
              "ipAddress": "A String", # IP address of the VPN gateway.
              "networkUri": "A String", # URI of a Compute Engine network where the VPN gateway is configured.
              "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured.
              "uri": "A String", # URI of a VPN gateway.
              "vpnTunnelUri": "A String", # A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed.
            },
            "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel.
              "displayName": "A String", # Name of a VPN tunnel.
              "networkUri": "A String", # URI of a Compute Engine network where the VPN tunnel is configured.
              "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured.
              "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel.
              "remoteGatewayIp": "A String", # Remote VPN gateway's IP address.
              "routingType": "A String", # Type of the routing policy.
              "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel.
              "sourceGatewayIp": "A String", # Local VPN gateway's IP address.
              "uri": "A String", # URI of a VPN tunnel.
            },
          },
        ],
      },
    ],
    "verifyTime": "A String", # The time of the configuration analysis.
  },
  "relatedProjects": [ # Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.
    "A String",
  ],
  "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.
    "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions).
      "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name.
    },
    "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI.
    "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).
    "instance": "A String", # A Compute Engine instance URI.
    "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](https://cloud.google.com/load-balancing/docs/load-balancing-overview).
    "network": "A String", # A Compute Engine network URI.
    "networkType": "A String", # Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.
    "port": 42, # The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
    "projectId": "A String", # Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.
  },
  "updateTime": "A String", # Output only. The time the test's configuration was updated.
}

  updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field.
  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 response of the operation in case of success. 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.
  },
}

rerun(name, body=None, x__xgafv=None)

Rerun an existing `ConnectivityTest`. After the user triggers the rerun, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. Even though the test configuration remains the same, the reachability result may change due to underlying network configuration changes. If the endpoint specifications in `ConnectivityTest` become invalid (for example, specified resources are deleted in the network, or you lost read permissions to the network configurations of listed projects), then the reachability result returns a value of `UNKNOWN`.

Args:
  name: string, Required. Connectivity Test resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for the `RerunConnectivityTest` method.
}

  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 response of the operation in case of success. 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.
  },
}

setIamPolicy(resource, body=None, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
        "auditLogConfigs": [ # The configuration for logging of each type of permission.
          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
              "A String",
            ],
            "logType": "A String", # The log type that this config enables.
          },
        ],
        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
      },
    ],
    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
      { # Associates `members`, or principals, with a `role`.
        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
        },
        "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
          "A String",
        ],
        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
      },
    ],
    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
  },
  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
      "auditLogConfigs": [ # The configuration for logging of each type of permission.
        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
            "A String",
          ],
          "logType": "A String", # The log type that this config enables.
        },
      ],
      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
    },
  ],
  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
    { # Associates `members`, or principals, with a `role`.
      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
      },
      "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
        "A String",
      ],
      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
    },
  ],
  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}

testIamPermissions(resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

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