Console
    Contact Us Start free

    Google Cloud Datastore Admin V1 Client - Class ExportEntitiesRequest (0.8.5)

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

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

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

    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.

    ↳ entity_filter
    Google\Cloud\Datastore\Admin\V1\EntityFilter

    Description of what data from the project is included in the export.

    ↳ output_url_prefix
    string

    Required. Location for the export metadata and data files. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH] , where BUCKET_NAME is the name of the Cloud Storage bucket and NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see Object name considerations . The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations. By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict.

    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

    getEntityFilter

    Description of what data from the project is included in the export.

    Returns
    Type
    Description
    Google\Cloud\Datastore\Admin\V1\EntityFilter |null

    hasEntityFilter

    clearEntityFilter

    setEntityFilter

    Description of what data from the project is included in the export.

    Parameter
    Name
    Description
    var
    Google\Cloud\Datastore\Admin\V1\EntityFilter
    Returns
    Type
    Description
    $this

    getOutputUrlPrefix

    Required. Location for the export metadata and data files.

    The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH] , where BUCKET_NAME is the name of the Cloud Storage bucket and NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see Object name considerations . The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations. By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict.

    Returns
    Type
    Description
    string

    setOutputUrlPrefix

    Required. Location for the export metadata and data files.

    The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH] , where BUCKET_NAME is the name of the Cloud Storage bucket and NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see Object name considerations . The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations. By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict.

    Parameter
    Name
    Description
    var
    string
    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.

    entityFilter
    Google\Cloud\Datastore\Admin\V1\EntityFilter

    Description of what data from the project is included in the export.

    outputUrlPrefix
    string

    Required. Location for the export metadata and data files.

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

    The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations.

    By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict.

    Returns
    Type
    Description
    Google\Cloud\Datastore\Admin\V1\ExportEntitiesRequest
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: