Console
    Contact Us Start free

    Google Cloud Datastore Admin V1 Client - Class ImportEntitiesRequest (1.0.4)

    Reference documentation and code samples for the Google Cloud Datastore Admin V1 Client class ImportEntitiesRequest.

    The request for google.datastore.admin.v1.DatastoreAdmin.ImportEntities .

    Generated from protobuf message google.datastore.admin.v1.ImportEntitiesRequest

    Namespace

    Google \ Cloud \ Datastore \ Admin \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ project_id
    string

    Required. Project ID against which to make the request.

    ↳ labels
    array| Google\Protobuf\Internal\MapField

    Client-assigned labels.

    ↳ input_url
    string

    Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE , where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations . For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url .

    ↳ entity_filter
    EntityFilter

    Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

    getProjectId

    Required. Project ID against which to make the request.

    Returns
    Type
    Description
    string

    setProjectId

    Required. Project ID against which to make the request.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getLabels

    Client-assigned labels.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    Client-assigned labels.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getInputUrl

    Required. The full resource URL of the external storage location.

    Currently, only Google Cloud Storage is supported. So input_url should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE , where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations . For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url .

    Returns
    Type
    Description
    string

    setInputUrl

    Required. The full resource URL of the external storage location.

    Currently, only Google Cloud Storage is supported. So input_url should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE , where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations . For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url .

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getEntityFilter

    Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

    Returns
    Type
    Description
    EntityFilter |null

    hasEntityFilter

    clearEntityFilter

    setEntityFilter

    Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

    Parameter
    Name
    Description
    var
    EntityFilter
    Returns
    Type
    Description
    $this

    static::build

    Parameters
    Name
    Description
    projectId
    string

    Required. Project ID against which to make the request.

    labels
    array

    Client-assigned labels.

    inputUrl
    string

    Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE , where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations .

    For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url .

    entityFilter
    EntityFilter

    Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

    Returns
    Type
    Description
    ImportEntitiesRequest
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: