Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage

Method Details

close()

Close httplib2 connections.

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

Create a Datastore for an org

Args:
  parent: string, Required. The parent organization name. Must be of the form `organizations/{org}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
  "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
  "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
    "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
    "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
    "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
    "projectId": "A String", # Required. GCP project in which the datastore exists
    "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
  },
  "displayName": "A String", # Required. Display name in UI
  "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
  "org": "A String", # Output only. Organization that the datastore belongs to
  "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
  "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
}

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

Returns:
  An object of the form:

    { # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
  "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
  "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
    "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
    "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
    "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
    "projectId": "A String", # Required. GCP project in which the datastore exists
    "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
  },
  "displayName": "A String", # Required. Display name in UI
  "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
  "org": "A String", # Output only. Organization that the datastore belongs to
  "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
  "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
}

delete(name, x__xgafv=None)

Delete a Datastore from an org.

Args:
  name: string, Required. Resource name of the Datastore to be deleted. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}

get(name, x__xgafv=None)

Get a Datastore

Args:
  name: string, Required. Resource name of the Datastore to be get. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
  "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
  "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
    "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
    "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
    "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
    "projectId": "A String", # Required. GCP project in which the datastore exists
    "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
  },
  "displayName": "A String", # Required. Display name in UI
  "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
  "org": "A String", # Output only. Organization that the datastore belongs to
  "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
  "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
}

list(parent, targetType=None, x__xgafv=None)

List Datastores

Args:
  parent: string, Required. The parent organization name. Must be of the form `organizations/{org}`. (required)
  targetType: string, Optional. TargetType is used to fetch all Datastores that match the type
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for ListDatastores
  "datastores": [ # A list of datastores
    { # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
      "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
      "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
        "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
        "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
        "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
        "projectId": "A String", # Required. GCP project in which the datastore exists
        "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
      },
      "displayName": "A String", # Required. Display name in UI
      "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
      "org": "A String", # Output only. Organization that the datastore belongs to
      "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
      "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
    },
  ],
}

test(parent, body=None, x__xgafv=None)

Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage

Args:
  parent: string, Required. The parent organization name Must be of the form `organizations/{org}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
  "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
  "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
    "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
    "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
    "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
    "projectId": "A String", # Required. GCP project in which the datastore exists
    "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
  },
  "displayName": "A String", # Required. Display name in UI
  "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
  "org": "A String", # Output only. Organization that the datastore belongs to
  "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
  "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
}

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

Returns:
  An object of the form:

    { # The response for TestDatastore
  "error": "A String", # Output only. Error message of test connection failure
  "state": "A String", # Output only. It could be `completed` or `failed`
}

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

Update a Datastore

Args:
  name: string, Required. The resource name of datastore to be updated. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
  "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
  "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
    "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
    "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
    "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
    "projectId": "A String", # Required. GCP project in which the datastore exists
    "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
  },
  "displayName": "A String", # Required. Display name in UI
  "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
  "org": "A String", # Output only. Organization that the datastore belongs to
  "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
  "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
}

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

Returns:
  An object of the form:

    { # The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
  "createTime": "A String", # Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
  "datastoreConfig": { # Configuration detail for datastore # Datastore Configurations.
    "bucketName": "A String", # Name of the Cloud Storage bucket. Required for `gcs` target_type.
    "datasetName": "A String", # BigQuery dataset name Required for `bigquery` target_type.
    "path": "A String", # Path of Cloud Storage bucket Required for `gcs` target_type.
    "projectId": "A String", # Required. GCP project in which the datastore exists
    "tablePrefix": "A String", # Prefix of BigQuery table Required for `bigquery` target_type.
  },
  "displayName": "A String", # Required. Display name in UI
  "lastUpdateTime": "A String", # Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z
  "org": "A String", # Output only. Organization that the datastore belongs to
  "self": "A String", # Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`
  "targetType": "A String", # Destination storage type. Supported types `gcs` or `bigquery`.
}

Apigee API . organizations . analytics . datastores

Instance Methods

Method Details