Close httplib2 connections.
Creates a new ServiceConnectionPolicy in a given project and location.
delete(name, etag=None, requestId=None, x__xgafv=None)
Deletes a single ServiceConnectionPolicy.
Gets details of a single ServiceConnectionPolicy.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists ServiceConnectionPolicies in a given project and location.
Retrieves the next page of results.
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single ServiceConnectionPolicy.
close()
Close httplib2 connections.
create(parent, autoSubnetworkConfig_allocRangeSpace=None, autoSubnetworkConfig_ipStack=None, autoSubnetworkConfig_prefixLength=None, body=None, requestId=None, serviceConnectionPolicyId=None, subnetworkMode=None, x__xgafv=None)
Creates a new ServiceConnectionPolicy in a given project and location.
Args:
parent: string, Required. The parent resource's name of the ServiceConnectionPolicy. ex. projects/123/locations/us-east1 (required)
body: object, The request body.
The object takes the form of:
{ # The ServiceConnectionPolicy resource.
"autoCreatedSubnetInfo": { # Information for the automatically created subnetwork and its associated IR. # Output only. Information for the automatically created subnetwork and its associated IR.
"delinked": True or False, # Output only. Indicates whether the subnetwork is delinked from the Service Connection Policy. Only set if the subnetwork mode is AUTO_CREATED during creation.
"internalRange": "A String", # Output only. URI of the automatically created Internal Range. Only set if the subnetwork mode is AUTO_CREATED during creation.
"internalRangeRef": "A String", # Output only. URI of the automatically created Internal Range reference. Only set if the subnetwork mode is AUTO_CREATED during creation.
"subnetwork": "A String", # Output only. URI of the automatically created subnetwork. Only set if the subnetwork mode is AUTO_CREATED during creation.
"subnetworkRef": "A String", # Output only. URI of the automatically created subnetwork reference. Only set if the subnetwork mode is AUTO_CREATED during creation.
},
"createTime": "A String", # Output only. Time when the ServiceConnectionPolicy was created.
"description": "A String", # A description of this resource.
"etag": "A String", # Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"infrastructure": "A String", # Output only. The type of underlying resources used to create the connection.
"labels": { # User-defined labels.
"a_key": "A String",
},
"name": "A String", # Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
"network": "A String", # The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.
"pscConfig": { # Configuration used for Private Service Connect connections. Used when Infrastructure is PSC. # Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.
"allowedGoogleProducersResourceHierarchyLevel": [ # Optional. List of Projects, Folders, or Organizations from where the Producer instance can be within. For example, a network administrator can provide both 'organizations/foo' and 'projects/bar' as allowed_google_producers_resource_hierarchy_levels. This allowlists this network to connect with any Producer instance within the 'foo' organization or the 'bar' project. By default, allowed_google_producers_resource_hierarchy_level is empty. The format for each allowed_google_producers_resource_hierarchy_level is / where is one of 'projects', 'folders', or 'organizations' and is either the ID or the number of the resource type. Format for each allowed_google_producers_resource_hierarchy_level value: 'projects/' or 'folders/' or 'organizations/' Eg. [projects/my-project-id, projects/567, folders/891, organizations/123]
"A String",
],
"limit": "A String", # Optional. Max number of PSC connections for this policy.
"producerInstanceLocation": "A String", # Optional. ProducerInstanceLocation is used to specify which authorization mechanism to use to determine which projects the Producer instance can be within.
"subnetworks": [ # The resource paths of subnetworks to use for IP address management. Example: projects/{projectNumOrId}/regions/{region}/subnetworks/{resourceId}.
"A String",
],
},
"pscConnections": [ # Output only. [Output only] Information about each Private Service Connect connection.
{ # Information about a specific Private Service Connect connection.
"consumerAddress": "A String", # The resource reference of the consumer address.
"consumerForwardingRule": "A String", # The resource reference of the PSC Forwarding Rule within the consumer VPC.
"consumerTargetProject": "A String", # The project where the PSC connection is created.
"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 most recent error during operating this connection. Deprecated, please use error_info instead.
"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.
},
"errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Output only. The error info for the latest error during operating this connection.
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
"metadata": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
"a_key": "A String",
},
"reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
},
"errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal.
"gceOperation": "A String", # The last Compute Engine operation to setup PSC connection.
"ipVersion": "A String", # The requested IP version for the PSC connection.
"producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance.
"producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata.
"a_key": "A String",
},
"pscConnectionId": "A String", # The PSC connection id of the PSC forwarding rule.
"selectedSubnetwork": "A String", # Output only. The URI of the subnetwork selected to allocate IP address for this connection.
"serviceClass": "A String", # Output only. [Output only] The service class associated with this PSC Connection. The value is derived from the SCPolicy and matches the service class name provided by the customer.
"state": "A String", # State of the PSC Connection
},
],
"serviceClass": "A String", # The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.
"updateTime": "A String", # Output only. Time when the ServiceConnectionPolicy was updated.
}
autoSubnetworkConfig_allocRangeSpace: string, Optional. The space where we search for a free range to create a subnetwork. It can be narrow down or pick a different space. This is in standard CIDR format. If not specified, “10.0.0.0/8” is used. Only eligible for IPV4_ONLY and IPV4_IPV6 subnetwork. (repeated)
autoSubnetworkConfig_ipStack: string, Optional. The requested IP stack for the subnetwork. If not specified, IPv4 is used.
Allowed values
SUBNET_IP_STACK_UNSPECIFIED - Default value. Will create an IPV4_ONLY subnetwork by default.
IPV4_ONLY - Will create an IPV4_ONLY subnetwork.
IPV6_ONLY - Will create an IPV6_ONLY subnetwork.
IPV4_IPV6 - Will use IPv4 and IPv6 (dual stack).
autoSubnetworkConfig_prefixLength: integer, Optional. The desired prefix length for the subnet's IP address range. E.g., 24 for a /24. The actual range is allocated from available space. If not specified, 24 is used. Only eligible for IPV4_ONLY and IPV4_IPV6 subnetwork.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
serviceConnectionPolicyId: string, Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionPolicies/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
subnetworkMode: string, Optional. If this field is not set, USER_PROVIDED is the inferred value to use.
Allowed values
SUBNETWORK_MODE_UNSPECIFIED - The default value if the enum is unset. Note user is not allowed to set the subnetwork mode to this value.
USER_PROVIDED - Subnetworks are provided from the user input.
AUTO_CREATED - Subnetwork list is empty from the user input. A subnetwork will be created automatically.
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, etag=None, requestId=None, x__xgafv=None)
Deletes a single ServiceConnectionPolicy.
Args:
name: string, Required. The name of the ServiceConnectionPolicy to delete. (required)
etag: string, Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Gets details of a single ServiceConnectionPolicy.
Args:
name: string, Required. Name of the ServiceConnectionPolicy to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The ServiceConnectionPolicy resource.
"autoCreatedSubnetInfo": { # Information for the automatically created subnetwork and its associated IR. # Output only. Information for the automatically created subnetwork and its associated IR.
"delinked": True or False, # Output only. Indicates whether the subnetwork is delinked from the Service Connection Policy. Only set if the subnetwork mode is AUTO_CREATED during creation.
"internalRange": "A String", # Output only. URI of the automatically created Internal Range. Only set if the subnetwork mode is AUTO_CREATED during creation.
"internalRangeRef": "A String", # Output only. URI of the automatically created Internal Range reference. Only set if the subnetwork mode is AUTO_CREATED during creation.
"subnetwork": "A String", # Output only. URI of the automatically created subnetwork. Only set if the subnetwork mode is AUTO_CREATED during creation.
"subnetworkRef": "A String", # Output only. URI of the automatically created subnetwork reference. Only set if the subnetwork mode is AUTO_CREATED during creation.
},
"createTime": "A String", # Output only. Time when the ServiceConnectionPolicy was created.
"description": "A String", # A description of this resource.
"etag": "A String", # Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"infrastructure": "A String", # Output only. The type of underlying resources used to create the connection.
"labels": { # User-defined labels.
"a_key": "A String",
},
"name": "A String", # Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
"network": "A String", # The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.
"pscConfig": { # Configuration used for Private Service Connect connections. Used when Infrastructure is PSC. # Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.
"allowedGoogleProducersResourceHierarchyLevel": [ # Optional. List of Projects, Folders, or Organizations from where the Producer instance can be within. For example, a network administrator can provide both 'organizations/foo' and 'projects/bar' as allowed_google_producers_resource_hierarchy_levels. This allowlists this network to connect with any Producer instance within the 'foo' organization or the 'bar' project. By default, allowed_google_producers_resource_hierarchy_level is empty. The format for each allowed_google_producers_resource_hierarchy_level is / where is one of 'projects', 'folders', or 'organizations' and is either the ID or the number of the resource type. Format for each allowed_google_producers_resource_hierarchy_level value: 'projects/' or 'folders/' or 'organizations/' Eg. [projects/my-project-id, projects/567, folders/891, organizations/123]
"A String",
],
"limit": "A String", # Optional. Max number of PSC connections for this policy.
"producerInstanceLocation": "A String", # Optional. ProducerInstanceLocation is used to specify which authorization mechanism to use to determine which projects the Producer instance can be within.
"subnetworks": [ # The resource paths of subnetworks to use for IP address management. Example: projects/{projectNumOrId}/regions/{region}/subnetworks/{resourceId}.
"A String",
],
},
"pscConnections": [ # Output only. [Output only] Information about each Private Service Connect connection.
{ # Information about a specific Private Service Connect connection.
"consumerAddress": "A String", # The resource reference of the consumer address.
"consumerForwardingRule": "A String", # The resource reference of the PSC Forwarding Rule within the consumer VPC.
"consumerTargetProject": "A String", # The project where the PSC connection is created.
"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 most recent error during operating this connection. Deprecated, please use error_info instead.
"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.
},
"errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Output only. The error info for the latest error during operating this connection.
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
"metadata": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
"a_key": "A String",
},
"reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
},
"errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal.
"gceOperation": "A String", # The last Compute Engine operation to setup PSC connection.
"ipVersion": "A String", # The requested IP version for the PSC connection.
"producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance.
"producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata.
"a_key": "A String",
},
"pscConnectionId": "A String", # The PSC connection id of the PSC forwarding rule.
"selectedSubnetwork": "A String", # Output only. The URI of the subnetwork selected to allocate IP address for this connection.
"serviceClass": "A String", # Output only. [Output only] The service class associated with this PSC Connection. The value is derived from the SCPolicy and matches the service class name provided by the customer.
"state": "A String", # State of the PSC Connection
},
],
"serviceClass": "A String", # The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.
"updateTime": "A String", # Output only. Time when the ServiceConnectionPolicy was updated.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists ServiceConnectionPolicies in a given project and location.
Args:
parent: string, Required. The parent resource's name. ex. projects/123/locations/us-east1 (required)
filter: string, A filter expression that filters the results listed in the response.
orderBy: string, Sort the results by a certain order.
pageSize: integer, The maximum number of results per page that should be returned.
pageToken: string, The page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListServiceConnectionPolicies.
"nextPageToken": "A String", # The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result.
"serviceConnectionPolicies": [ # ServiceConnectionPolicies to be returned.
{ # The ServiceConnectionPolicy resource.
"autoCreatedSubnetInfo": { # Information for the automatically created subnetwork and its associated IR. # Output only. Information for the automatically created subnetwork and its associated IR.
"delinked": True or False, # Output only. Indicates whether the subnetwork is delinked from the Service Connection Policy. Only set if the subnetwork mode is AUTO_CREATED during creation.
"internalRange": "A String", # Output only. URI of the automatically created Internal Range. Only set if the subnetwork mode is AUTO_CREATED during creation.
"internalRangeRef": "A String", # Output only. URI of the automatically created Internal Range reference. Only set if the subnetwork mode is AUTO_CREATED during creation.
"subnetwork": "A String", # Output only. URI of the automatically created subnetwork. Only set if the subnetwork mode is AUTO_CREATED during creation.
"subnetworkRef": "A String", # Output only. URI of the automatically created subnetwork reference. Only set if the subnetwork mode is AUTO_CREATED during creation.
},
"createTime": "A String", # Output only. Time when the ServiceConnectionPolicy was created.
"description": "A String", # A description of this resource.
"etag": "A String", # Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"infrastructure": "A String", # Output only. The type of underlying resources used to create the connection.
"labels": { # User-defined labels.
"a_key": "A String",
},
"name": "A String", # Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
"network": "A String", # The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.
"pscConfig": { # Configuration used for Private Service Connect connections. Used when Infrastructure is PSC. # Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.
"allowedGoogleProducersResourceHierarchyLevel": [ # Optional. List of Projects, Folders, or Organizations from where the Producer instance can be within. For example, a network administrator can provide both 'organizations/foo' and 'projects/bar' as allowed_google_producers_resource_hierarchy_levels. This allowlists this network to connect with any Producer instance within the 'foo' organization or the 'bar' project. By default, allowed_google_producers_resource_hierarchy_level is empty. The format for each allowed_google_producers_resource_hierarchy_level is / where is one of 'projects', 'folders', or 'organizations' and is either the ID or the number of the resource type. Format for each allowed_google_producers_resource_hierarchy_level value: 'projects/' or 'folders/' or 'organizations/' Eg. [projects/my-project-id, projects/567, folders/891, organizations/123]
"A String",
],
"limit": "A String", # Optional. Max number of PSC connections for this policy.
"producerInstanceLocation": "A String", # Optional. ProducerInstanceLocation is used to specify which authorization mechanism to use to determine which projects the Producer instance can be within.
"subnetworks": [ # The resource paths of subnetworks to use for IP address management. Example: projects/{projectNumOrId}/regions/{region}/subnetworks/{resourceId}.
"A String",
],
},
"pscConnections": [ # Output only. [Output only] Information about each Private Service Connect connection.
{ # Information about a specific Private Service Connect connection.
"consumerAddress": "A String", # The resource reference of the consumer address.
"consumerForwardingRule": "A String", # The resource reference of the PSC Forwarding Rule within the consumer VPC.
"consumerTargetProject": "A String", # The project where the PSC connection is created.
"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 most recent error during operating this connection. Deprecated, please use error_info instead.
"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.
},
"errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Output only. The error info for the latest error during operating this connection.
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
"metadata": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
"a_key": "A String",
},
"reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
},
"errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal.
"gceOperation": "A String", # The last Compute Engine operation to setup PSC connection.
"ipVersion": "A String", # The requested IP version for the PSC connection.
"producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance.
"producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata.
"a_key": "A String",
},
"pscConnectionId": "A String", # The PSC connection id of the PSC forwarding rule.
"selectedSubnetwork": "A String", # Output only. The URI of the subnetwork selected to allocate IP address for this connection.
"serviceClass": "A String", # Output only. [Output only] The service class associated with this PSC Connection. The value is derived from the SCPolicy and matches the service class name provided by the customer.
"state": "A String", # State of the PSC Connection
},
],
"serviceClass": "A String", # The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.
"updateTime": "A String", # Output only. Time when the ServiceConnectionPolicy was updated.
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
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, requestId=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single ServiceConnectionPolicy.
Args:
name: string, Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names (required)
body: object, The request body.
The object takes the form of:
{ # The ServiceConnectionPolicy resource.
"autoCreatedSubnetInfo": { # Information for the automatically created subnetwork and its associated IR. # Output only. Information for the automatically created subnetwork and its associated IR.
"delinked": True or False, # Output only. Indicates whether the subnetwork is delinked from the Service Connection Policy. Only set if the subnetwork mode is AUTO_CREATED during creation.
"internalRange": "A String", # Output only. URI of the automatically created Internal Range. Only set if the subnetwork mode is AUTO_CREATED during creation.
"internalRangeRef": "A String", # Output only. URI of the automatically created Internal Range reference. Only set if the subnetwork mode is AUTO_CREATED during creation.
"subnetwork": "A String", # Output only. URI of the automatically created subnetwork. Only set if the subnetwork mode is AUTO_CREATED during creation.
"subnetworkRef": "A String", # Output only. URI of the automatically created subnetwork reference. Only set if the subnetwork mode is AUTO_CREATED during creation.
},
"createTime": "A String", # Output only. Time when the ServiceConnectionPolicy was created.
"description": "A String", # A description of this resource.
"etag": "A String", # Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"infrastructure": "A String", # Output only. The type of underlying resources used to create the connection.
"labels": { # User-defined labels.
"a_key": "A String",
},
"name": "A String", # Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
"network": "A String", # The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.
"pscConfig": { # Configuration used for Private Service Connect connections. Used when Infrastructure is PSC. # Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.
"allowedGoogleProducersResourceHierarchyLevel": [ # Optional. List of Projects, Folders, or Organizations from where the Producer instance can be within. For example, a network administrator can provide both 'organizations/foo' and 'projects/bar' as allowed_google_producers_resource_hierarchy_levels. This allowlists this network to connect with any Producer instance within the 'foo' organization or the 'bar' project. By default, allowed_google_producers_resource_hierarchy_level is empty. The format for each allowed_google_producers_resource_hierarchy_level is / where is one of 'projects', 'folders', or 'organizations' and is either the ID or the number of the resource type. Format for each allowed_google_producers_resource_hierarchy_level value: 'projects/' or 'folders/' or 'organizations/' Eg. [projects/my-project-id, projects/567, folders/891, organizations/123]
"A String",
],
"limit": "A String", # Optional. Max number of PSC connections for this policy.
"producerInstanceLocation": "A String", # Optional. ProducerInstanceLocation is used to specify which authorization mechanism to use to determine which projects the Producer instance can be within.
"subnetworks": [ # The resource paths of subnetworks to use for IP address management. Example: projects/{projectNumOrId}/regions/{region}/subnetworks/{resourceId}.
"A String",
],
},
"pscConnections": [ # Output only. [Output only] Information about each Private Service Connect connection.
{ # Information about a specific Private Service Connect connection.
"consumerAddress": "A String", # The resource reference of the consumer address.
"consumerForwardingRule": "A String", # The resource reference of the PSC Forwarding Rule within the consumer VPC.
"consumerTargetProject": "A String", # The project where the PSC connection is created.
"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 most recent error during operating this connection. Deprecated, please use error_info instead.
"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.
},
"errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Output only. The error info for the latest error during operating this connection.
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
"metadata": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
"a_key": "A String",
},
"reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
},
"errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal.
"gceOperation": "A String", # The last Compute Engine operation to setup PSC connection.
"ipVersion": "A String", # The requested IP version for the PSC connection.
"producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance.
"producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata.
"a_key": "A String",
},
"pscConnectionId": "A String", # The PSC connection id of the PSC forwarding rule.
"selectedSubnetwork": "A String", # Output only. The URI of the subnetwork selected to allocate IP address for this connection.
"serviceClass": "A String", # Output only. [Output only] The service class associated with this PSC Connection. The value is derived from the SCPolicy and matches the service class name provided by the customer.
"state": "A String", # State of the PSC Connection
},
],
"serviceClass": "A String", # The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.
"updateTime": "A String", # Output only. Time when the ServiceConnectionPolicy was updated.
}
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the ServiceConnectionPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}