close()

Close httplib2 connections.

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

Creates a new VPC Flow Logs configuration. If a configuration with the exact same settings already exists, the creation fails.

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

{ # A configuration to generate VPC Flow Logs.
"aggregationInterval": "A String", # Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
"createTime": "A String", # Output only. The time the config was created.
"description": "A String", # Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
"filterExpr": "A String", # Export filter used to define which VPC flow logs should be logged.
"flowSampling": 3.14, # Optional. The value of the field must be in [0, 1]. The sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default value is 1.0.
"interconnectAttachment": "A String", # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/locations/{region}/interconnectAttachments/{name}
"labels": { # Optional. Resource labels to represent user-provided metadata.
"a_key": "A String",
},
"metadata": "A String", # Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
"metadataFields": [ # Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
"A String",
],
"name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogs/{vpc_flow_log}`
"network": "A String", # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/networks/{name}
"state": "A String", # Optional. The state of the VPC Flow Log. Default value is ENABLED.
"subnet": "A String", # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/locations/{region}/subnetworks/{name}
"updateTime": "A String", # Output only. The time the config was updated.
"vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/locations/{region}/vpnTunnels/{name}
}

vpcFlowLogsConfigId: string, Required. ID of the VpcFlowLogsConfig.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

delete(name, x__xgafv=None)

Deletes a specific VpcFlowLog configuration.

Args:
name: string, Required. VpcFlowLogsConfig name using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}` (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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Gets the details of a specific VPC Flow Log configuration.

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

Returns:
  An object of the form:

    { # A configuration to generate VPC Flow Logs.
  "aggregationInterval": "A String", # Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
  "createTime": "A String", # Output only. The time the config was created.
  "description": "A String", # Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
  "filterExpr": "A String", # Export filter used to define which VPC flow logs should be logged.
  "flowSampling": 3.14, # Optional. The value of the field must be in [0, 1]. The sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default value is 1.0.
  "interconnectAttachment": "A String", # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/locations/{region}/interconnectAttachments/{name}
  "labels": { # Optional. Resource labels to represent user-provided metadata.
    "a_key": "A String",
  },
  "metadata": "A String", # Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
  "metadataFields": [ # Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
    "A String",
  ],
  "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogs/{vpc_flow_log}`
  "network": "A String", # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/networks/{name}
  "state": "A String", # Optional. The state of the VPC Flow Log. Default value is ENABLED.
  "subnet": "A String", # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/locations/{region}/subnetworks/{name}
  "updateTime": "A String", # Output only. The time the config was updated.
  "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/locations/{region}/vpnTunnels/{name}
}

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

Lists all VPC Flow Logs configurations in a given project.

Args:
  parent: string, Required. The parent resource of the VpcFlowLogsConfig: `projects/{project_id}/locations/global` (required)
  filter: string, Optional. Lists the `VpcFlowLogsConfig`s 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/vpcFlowLogsConfigs/config-1 - Filter by target resource: - Configurations at the VPC network level target_resource.network:* - Configurations for a VPC network called `vpc-1` target_resource.network = vpc-1
  orderBy: string, Optional. Field to use to sort the list.
  pageSize: integer, Optional. Number of `VpcFlowLogsConfig`s to return.
  pageToken: string, Optional. 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 `ListVpcFlowLogsConfigs` method.
  "nextPageToken": "A String", # Page token to fetch the next set of configurations.
  "unreachable": [ # Locations that could not be reached (when querying all locations with `-`).
    "A String",
  ],
  "vpcFlowLogsConfigs": [ # List of VPC Flow Log configurations.
    { # A configuration to generate VPC Flow Logs.
      "aggregationInterval": "A String", # Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
      "createTime": "A String", # Output only. The time the config was created.
      "description": "A String", # Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
      "filterExpr": "A String", # Export filter used to define which VPC flow logs should be logged.
      "flowSampling": 3.14, # Optional. The value of the field must be in [0, 1]. The sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default value is 1.0.
      "interconnectAttachment": "A String", # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/locations/{region}/interconnectAttachments/{name}
      "labels": { # Optional. Resource labels to represent user-provided metadata.
        "a_key": "A String",
      },
      "metadata": "A String", # Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
      "metadataFields": [ # Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
        "A String",
      ],
      "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogs/{vpc_flow_log}`
      "network": "A String", # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/networks/{name}
      "state": "A String", # Optional. The state of the VPC Flow Log. Default value is ENABLED.
      "subnet": "A String", # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/locations/{region}/subnetworks/{name}
      "updateTime": "A String", # Output only. The time the config was updated.
      "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/locations/{region}/vpnTunnels/{name}
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an existing VpcFlowLogsConfig. If a configuration with the exact same settings already exists, the creation fails.

Args:
name: string, Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogs/{vpc_flow_log}` (required)
body: object, The request body.
The object takes the form of:

{ # A configuration to generate VPC Flow Logs.
"aggregationInterval": "A String", # Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
"createTime": "A String", # Output only. The time the config was created.
"description": "A String", # Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
"filterExpr": "A String", # Export filter used to define which VPC flow logs should be logged.
"flowSampling": 3.14, # Optional. The value of the field must be in [0, 1]. The sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default value is 1.0.
"interconnectAttachment": "A String", # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/locations/{region}/interconnectAttachments/{name}
"labels": { # Optional. Resource labels to represent user-provided metadata.
"a_key": "A String",
},
"metadata": "A String", # Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
"metadataFields": [ # Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
"A String",
],
"name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogs/{vpc_flow_log}`
"network": "A String", # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/networks/{name}
"state": "A String", # Optional. The state of the VPC Flow Log. Default value is ENABLED.
"subnet": "A String", # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/locations/{region}/subnetworks/{name}
"updateTime": "A String", # Output only. The time the config was updated.
"vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/locations/{region}/vpnTunnels/{name}
}

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, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

Network Management API . projects . locations . vpcFlowLogsConfigs

Instance Methods

Method Details