Close httplib2 connections.
create(parent, body=None, requestId=None, serviceConnectionMapId=None, x__xgafv=None)
Creates a new ServiceConnectionMap in a given project and location.
delete(name, etag=None, requestId=None, x__xgafv=None)
Deletes a single ServiceConnectionMap.
Gets details of a single ServiceConnectionMap.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists ServiceConnectionMaps 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 ServiceConnectionMap.
close()
Close httplib2 connections.
create(parent, body=None, requestId=None, serviceConnectionMapId=None, x__xgafv=None)
Creates a new ServiceConnectionMap in a given project and location.
Args:
parent: string, Required. The parent resource's name of the ServiceConnectionMap. ex. projects/123/locations/us-east1 (required)
body: object, The request body.
The object takes the form of:
{ # The ServiceConnectionMap resource.
"consumerPscConfigs": [ # The PSC configurations on consumer side.
{ # Allow the producer to specify which consumers can connect to it.
"consumerInstanceProject": "A String", # Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/' Eg. 'projects/consumer-project' or 'projects/1234'
"disableGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
"ipVersion": "A String", # The requested IP version for the PSC connection.
"network": "A String", # The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}.
"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",
},
"project": "A String", # The consumer project where PSC connections are allowed to be created in.
"serviceAttachmentIpAddressMap": { # Optional. A map to store mapping between customer vip and target service attachment. This field can be used to specify a static IP address for a PSC connection.
"a_key": "A String",
},
"state": "A String", # Output only. Overall state of PSC Connections management for this consumer psc config.
},
],
"consumerPscConnections": [ # Output only. PSC connection details on consumer side.
{ # PSC connection details on consumer side.
"dnsAutomationStatus": { # The status of DNS automation for a PSC connection. # Output only. The status of DNS automation for this PSC connection.
"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). # Output only. The error details if the state is CREATE_FAILED or DELETE_FAILED.
"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.
},
"fqdn": "A String", # Output only. The fully qualified domain name of the DNS record.
"state": "A String", # Output only. The current state of DNS automation.
},
"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.
"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.
"forwardingRule": "A String", # The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}.
"gceOperation": "A String", # The last Compute Engine operation to setup PSC connection.
"ip": "A String", # The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map.
"ipVersion": "A String", # The requested IP version for the PSC connection.
"network": "A String", # The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map. Note that the network could be on a different project (shared VPC).
"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",
},
"project": "A String", # The consumer project whose PSC forwarding rule is connected to the service attachments in this service connection map.
"pscConnectionId": "A String", # The PSC connection id of the PSC forwarding rule connected to the service attachments in this service connection map.
"selectedSubnetwork": "A String", # Output only. The URI of the selected subnetwork selected to allocate IP address for this connection.
"serviceAttachmentUri": "A String", # The URI of a service attachment which is the target of the PSC connection.
"state": "A String", # The state of the PSC connection.
},
],
"createTime": "A String", # Output only. Time when the ServiceConnectionMap 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 infrastructure used for connections between consumers/producers.
"labels": { # User-defined labels.
"a_key": "A String",
},
"name": "A String", # Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names
"producerPscConfigs": [ # The PSC configurations on producer side.
{ # The PSC configurations on producer side.
"automatedDnsCreationSpec": { # The specification for automatically creating a DNS record. # Optional. The specification for automatically creating a DNS record for this PSC connection.
"dnsSuffix": "A String", # Required. The DNS suffix to use for the DNS record. Must end with a dot. This should be a valid DNS domain name as per RFC 1035. Each label (between dots) can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-service.example.com.", "internal."
"hostname": "A String", # Required. The hostname (the first label of the FQDN) to use for the DNS record. This should be a valid DNS label as per RFC 1035. Generally, this means the hostname can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-instance", "db-1"
"ttl": "A String", # Optional. The Time To Live for the DNS record, in seconds. If not provided, a default of 30 seconds will be used.
},
"serviceAttachmentUri": "A String", # The resource path of a service attachment. Example: projects/{projectNumOrId}/regions/{region}/serviceAttachments/{resourceId}.
},
],
"serviceClass": "A String", # The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnectivity.serviceClasses.use IAM permission for the service class.
"serviceClassUri": "A String", # Output only. The service class uri this ServiceConnectionMap is for.
"token": "A String", # The token provided by the consumer. This token authenticates that the consumer can create a connection within the specified project and network.
"updateTime": "A String", # Output only. Time when the ServiceConnectionMap 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).
serviceConnectionMapId: string, Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionMaps/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated.
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 ServiceConnectionMap.
Args:
name: string, Required. The name of the ServiceConnectionMap 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 ServiceConnectionMap.
Args:
name: string, Required. Name of the ServiceConnectionMap 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 ServiceConnectionMap resource.
"consumerPscConfigs": [ # The PSC configurations on consumer side.
{ # Allow the producer to specify which consumers can connect to it.
"consumerInstanceProject": "A String", # Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/' Eg. 'projects/consumer-project' or 'projects/1234'
"disableGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
"ipVersion": "A String", # The requested IP version for the PSC connection.
"network": "A String", # The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}.
"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",
},
"project": "A String", # The consumer project where PSC connections are allowed to be created in.
"serviceAttachmentIpAddressMap": { # Optional. A map to store mapping between customer vip and target service attachment. This field can be used to specify a static IP address for a PSC connection.
"a_key": "A String",
},
"state": "A String", # Output only. Overall state of PSC Connections management for this consumer psc config.
},
],
"consumerPscConnections": [ # Output only. PSC connection details on consumer side.
{ # PSC connection details on consumer side.
"dnsAutomationStatus": { # The status of DNS automation for a PSC connection. # Output only. The status of DNS automation for this PSC connection.
"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). # Output only. The error details if the state is CREATE_FAILED or DELETE_FAILED.
"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.
},
"fqdn": "A String", # Output only. The fully qualified domain name of the DNS record.
"state": "A String", # Output only. The current state of DNS automation.
},
"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.
"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.
"forwardingRule": "A String", # The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}.
"gceOperation": "A String", # The last Compute Engine operation to setup PSC connection.
"ip": "A String", # The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map.
"ipVersion": "A String", # The requested IP version for the PSC connection.
"network": "A String", # The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map. Note that the network could be on a different project (shared VPC).
"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",
},
"project": "A String", # The consumer project whose PSC forwarding rule is connected to the service attachments in this service connection map.
"pscConnectionId": "A String", # The PSC connection id of the PSC forwarding rule connected to the service attachments in this service connection map.
"selectedSubnetwork": "A String", # Output only. The URI of the selected subnetwork selected to allocate IP address for this connection.
"serviceAttachmentUri": "A String", # The URI of a service attachment which is the target of the PSC connection.
"state": "A String", # The state of the PSC connection.
},
],
"createTime": "A String", # Output only. Time when the ServiceConnectionMap 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 infrastructure used for connections between consumers/producers.
"labels": { # User-defined labels.
"a_key": "A String",
},
"name": "A String", # Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names
"producerPscConfigs": [ # The PSC configurations on producer side.
{ # The PSC configurations on producer side.
"automatedDnsCreationSpec": { # The specification for automatically creating a DNS record. # Optional. The specification for automatically creating a DNS record for this PSC connection.
"dnsSuffix": "A String", # Required. The DNS suffix to use for the DNS record. Must end with a dot. This should be a valid DNS domain name as per RFC 1035. Each label (between dots) can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-service.example.com.", "internal."
"hostname": "A String", # Required. The hostname (the first label of the FQDN) to use for the DNS record. This should be a valid DNS label as per RFC 1035. Generally, this means the hostname can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-instance", "db-1"
"ttl": "A String", # Optional. The Time To Live for the DNS record, in seconds. If not provided, a default of 30 seconds will be used.
},
"serviceAttachmentUri": "A String", # The resource path of a service attachment. Example: projects/{projectNumOrId}/regions/{region}/serviceAttachments/{resourceId}.
},
],
"serviceClass": "A String", # The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnectivity.serviceClasses.use IAM permission for the service class.
"serviceClassUri": "A String", # Output only. The service class uri this ServiceConnectionMap is for.
"token": "A String", # The token provided by the consumer. This token authenticates that the consumer can create a connection within the specified project and network.
"updateTime": "A String", # Output only. Time when the ServiceConnectionMap was updated.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists ServiceConnectionMaps 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 ListServiceConnectionMaps.
"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.
"serviceConnectionMaps": [ # ServiceConnectionMaps to be returned.
{ # The ServiceConnectionMap resource.
"consumerPscConfigs": [ # The PSC configurations on consumer side.
{ # Allow the producer to specify which consumers can connect to it.
"consumerInstanceProject": "A String", # Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/' Eg. 'projects/consumer-project' or 'projects/1234'
"disableGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
"ipVersion": "A String", # The requested IP version for the PSC connection.
"network": "A String", # The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}.
"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",
},
"project": "A String", # The consumer project where PSC connections are allowed to be created in.
"serviceAttachmentIpAddressMap": { # Optional. A map to store mapping between customer vip and target service attachment. This field can be used to specify a static IP address for a PSC connection.
"a_key": "A String",
},
"state": "A String", # Output only. Overall state of PSC Connections management for this consumer psc config.
},
],
"consumerPscConnections": [ # Output only. PSC connection details on consumer side.
{ # PSC connection details on consumer side.
"dnsAutomationStatus": { # The status of DNS automation for a PSC connection. # Output only. The status of DNS automation for this PSC connection.
"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). # Output only. The error details if the state is CREATE_FAILED or DELETE_FAILED.
"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.
},
"fqdn": "A String", # Output only. The fully qualified domain name of the DNS record.
"state": "A String", # Output only. The current state of DNS automation.
},
"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.
"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.
"forwardingRule": "A String", # The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}.
"gceOperation": "A String", # The last Compute Engine operation to setup PSC connection.
"ip": "A String", # The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map.
"ipVersion": "A String", # The requested IP version for the PSC connection.
"network": "A String", # The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map. Note that the network could be on a different project (shared VPC).
"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",
},
"project": "A String", # The consumer project whose PSC forwarding rule is connected to the service attachments in this service connection map.
"pscConnectionId": "A String", # The PSC connection id of the PSC forwarding rule connected to the service attachments in this service connection map.
"selectedSubnetwork": "A String", # Output only. The URI of the selected subnetwork selected to allocate IP address for this connection.
"serviceAttachmentUri": "A String", # The URI of a service attachment which is the target of the PSC connection.
"state": "A String", # The state of the PSC connection.
},
],
"createTime": "A String", # Output only. Time when the ServiceConnectionMap 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 infrastructure used for connections between consumers/producers.
"labels": { # User-defined labels.
"a_key": "A String",
},
"name": "A String", # Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names
"producerPscConfigs": [ # The PSC configurations on producer side.
{ # The PSC configurations on producer side.
"automatedDnsCreationSpec": { # The specification for automatically creating a DNS record. # Optional. The specification for automatically creating a DNS record for this PSC connection.
"dnsSuffix": "A String", # Required. The DNS suffix to use for the DNS record. Must end with a dot. This should be a valid DNS domain name as per RFC 1035. Each label (between dots) can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-service.example.com.", "internal."
"hostname": "A String", # Required. The hostname (the first label of the FQDN) to use for the DNS record. This should be a valid DNS label as per RFC 1035. Generally, this means the hostname can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-instance", "db-1"
"ttl": "A String", # Optional. The Time To Live for the DNS record, in seconds. If not provided, a default of 30 seconds will be used.
},
"serviceAttachmentUri": "A String", # The resource path of a service attachment. Example: projects/{projectNumOrId}/regions/{region}/serviceAttachments/{resourceId}.
},
],
"serviceClass": "A String", # The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnectivity.serviceClasses.use IAM permission for the service class.
"serviceClassUri": "A String", # Output only. The service class uri this ServiceConnectionMap is for.
"token": "A String", # The token provided by the consumer. This token authenticates that the consumer can create a connection within the specified project and network.
"updateTime": "A String", # Output only. Time when the ServiceConnectionMap 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 ServiceConnectionMap.
Args:
name: string, Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names (required)
body: object, The request body.
The object takes the form of:
{ # The ServiceConnectionMap resource.
"consumerPscConfigs": [ # The PSC configurations on consumer side.
{ # Allow the producer to specify which consumers can connect to it.
"consumerInstanceProject": "A String", # Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/' Eg. 'projects/consumer-project' or 'projects/1234'
"disableGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
"ipVersion": "A String", # The requested IP version for the PSC connection.
"network": "A String", # The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}.
"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",
},
"project": "A String", # The consumer project where PSC connections are allowed to be created in.
"serviceAttachmentIpAddressMap": { # Optional. A map to store mapping between customer vip and target service attachment. This field can be used to specify a static IP address for a PSC connection.
"a_key": "A String",
},
"state": "A String", # Output only. Overall state of PSC Connections management for this consumer psc config.
},
],
"consumerPscConnections": [ # Output only. PSC connection details on consumer side.
{ # PSC connection details on consumer side.
"dnsAutomationStatus": { # The status of DNS automation for a PSC connection. # Output only. The status of DNS automation for this PSC connection.
"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). # Output only. The error details if the state is CREATE_FAILED or DELETE_FAILED.
"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.
},
"fqdn": "A String", # Output only. The fully qualified domain name of the DNS record.
"state": "A String", # Output only. The current state of DNS automation.
},
"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.
"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.
"forwardingRule": "A String", # The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}.
"gceOperation": "A String", # The last Compute Engine operation to setup PSC connection.
"ip": "A String", # The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map.
"ipVersion": "A String", # The requested IP version for the PSC connection.
"network": "A String", # The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map. Note that the network could be on a different project (shared VPC).
"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",
},
"project": "A String", # The consumer project whose PSC forwarding rule is connected to the service attachments in this service connection map.
"pscConnectionId": "A String", # The PSC connection id of the PSC forwarding rule connected to the service attachments in this service connection map.
"selectedSubnetwork": "A String", # Output only. The URI of the selected subnetwork selected to allocate IP address for this connection.
"serviceAttachmentUri": "A String", # The URI of a service attachment which is the target of the PSC connection.
"state": "A String", # The state of the PSC connection.
},
],
"createTime": "A String", # Output only. Time when the ServiceConnectionMap 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 infrastructure used for connections between consumers/producers.
"labels": { # User-defined labels.
"a_key": "A String",
},
"name": "A String", # Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names
"producerPscConfigs": [ # The PSC configurations on producer side.
{ # The PSC configurations on producer side.
"automatedDnsCreationSpec": { # The specification for automatically creating a DNS record. # Optional. The specification for automatically creating a DNS record for this PSC connection.
"dnsSuffix": "A String", # Required. The DNS suffix to use for the DNS record. Must end with a dot. This should be a valid DNS domain name as per RFC 1035. Each label (between dots) can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-service.example.com.", "internal."
"hostname": "A String", # Required. The hostname (the first label of the FQDN) to use for the DNS record. This should be a valid DNS label as per RFC 1035. Generally, this means the hostname can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-instance", "db-1"
"ttl": "A String", # Optional. The Time To Live for the DNS record, in seconds. If not provided, a default of 30 seconds will be used.
},
"serviceAttachmentUri": "A String", # The resource path of a service attachment. Example: projects/{projectNumOrId}/regions/{region}/serviceAttachments/{resourceId}.
},
],
"serviceClass": "A String", # The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnectivity.serviceClasses.use IAM permission for the service class.
"serviceClassUri": "A String", # Output only. The service class uri this ServiceConnectionMap is for.
"token": "A String", # The token provided by the consumer. This token authenticates that the consumer can create a connection within the specified project and network.
"updateTime": "A String", # Output only. Time when the ServiceConnectionMap 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 ServiceConnectionMap 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.
},
}