Connectors API . projects . locations

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets information about a location.

Args:
  name: string, Resource name for the location. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource that represents a Google Cloud location.
  "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
  "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
    "a_key": "A String",
  },
  "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
  "metadata": { # Service-specific metadata. For example the available capacity at the given location.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
}

getRegionalSettings(name, x__xgafv=None)

GetRegionalSettings gets settings of a region. RegionalSettings is a singleton resource.

Args:
  name: string, Required. The resource name of the Regional Settings. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Regional Settings details.
  "encryptionConfig": { # Regional encryption config for CMEK details. # Optional. Regional encryption config to hold CMEK details.
    "encryptionType": "A String", # Optional. Encryption type for the region.
    "kmsKeyName": "A String", # Optional. KMS crypto key. This field accepts identifiers of the form `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/ {crypto_key}`
  },
  "name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/regionalSettings
  "networkConfig": { # Regional Network Config. # Optional. Regional network config.
    "egressIps": [ # Output only. Egress IPs
      "A String",
    ],
    "egressMode": "A String", # Optional. Egress mode for the network.
  },
  "provisioned": True or False, # Output only. Specifies whether the region is provisioned.
}

getRuntimeConfig(name, x__xgafv=None)

Gets the runtimeConfig of a location. RuntimeConfig is a singleton resource for each location.

Args:
  name: string, Required. Resource name of the form: `projects/*/locations/*/runtimeConfig` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # RuntimeConfig is the singleton resource of each location. It includes generic resource configs consumed by control plane and runtime plane like: pub/sub topic/subscription resource name, Cloud Storage location storing schema etc.
  "conndSubscription": "A String", # Output only. Pub/Sub subscription for connd to receive message. E.g. projects/{project-id}/subscriptions/{topic-id}
  "conndTopic": "A String", # Output only. Pub/Sub topic for connd to send message. E.g. projects/{project-id}/topics/{topic-id}
  "controlPlaneSubscription": "A String", # Output only. Pub/Sub subscription for control plane to receive message. E.g. projects/{project-id}/subscriptions/{topic-id}
  "controlPlaneTopic": "A String", # Output only. Pub/Sub topic for control plne to send message. communication. E.g. projects/{project-id}/topics/{topic-id}
  "locationId": "A String", # Output only. location_id of the runtime location. E.g. "us-west1".
  "name": "A String", # Output only. Name of the runtimeConfig resource. Format: projects/{project}/locations/{location}/runtimeConfig
  "runtimeEndpoint": "A String", # Output only. The endpoint of the connectors runtime ingress.
  "schemaGcsBucket": "A String", # Output only. The Cloud Storage bucket that stores connector's schema reports.
  "serviceDirectory": "A String", # Output only. The name of the Service Directory service name.
  "state": "A String", # Output only. The state of the location.
}

list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists information about the supported locations for this service.

Args:
  name: string, The resource that owns the locations collection, if applicable. (required)
  filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
  pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
  pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Locations.ListLocations.
  "locations": [ # A list of locations that matches the specified filter in the request.
    { # A resource that represents a Google Cloud location.
      "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
      "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
        "a_key": "A String",
      },
      "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
      "metadata": { # Service-specific metadata. For example the available capacity at the given location.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
    },
  ],
  "nextPageToken": "A String", # The standard List next-page token.
}

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.
        

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

Update the settings of a region.

Args:
  name: string, Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/regionalSettings (required)
  body: object, The request body.
    The object takes the form of:

{ # Regional Settings details.
  "encryptionConfig": { # Regional encryption config for CMEK details. # Optional. Regional encryption config to hold CMEK details.
    "encryptionType": "A String", # Optional. Encryption type for the region.
    "kmsKeyName": "A String", # Optional. KMS crypto key. This field accepts identifiers of the form `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/ {crypto_key}`
  },
  "name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/regionalSettings
  "networkConfig": { # Regional Network Config. # Optional. Regional network config.
    "egressIps": [ # Output only. Egress IPs
      "A String",
    ],
    "egressMode": "A String", # Optional. Egress mode for the network.
  },
  "provisioned": True or False, # Output only. Specifies whether the region is provisioned.
}

  updateMask: string, Required. The list of fields to update.
  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.
  },
}