Cloud Firestore Admin V1 API - Module Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Paths (v1.7.0)

Reference documentation and code samples for the Cloud Firestore Admin V1 API module Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Paths.

Path helper methods for the FirestoreAdmin API.

Extended By

Methods

#backup_path

def backup_path(project:, location:, backup:) -> ::String

Create a fully-qualified Backup resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/backups/{backup}

Parameters
  • project (String)
  • location (String)
  • backup (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#backup_schedule_path

def backup_schedule_path(project:, database:, backup_schedule:) -> ::String

Create a fully-qualified BackupSchedule resource string.

The resource will be in the following format:

projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

Parameters
  • project (String)
  • database (String)
  • backup_schedule (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#collection_group_path

def collection_group_path(project:, database:, collection:) -> ::String

Create a fully-qualified CollectionGroup resource string.

The resource will be in the following format:

projects/{project}/databases/{database}/collectionGroups/{collection}

Parameters
  • project (String)
  • database (String)
  • collection (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#database_path

def database_path(project:, database:) -> ::String

Create a fully-qualified Database resource string.

The resource will be in the following format:

projects/{project}/databases/{database}

Parameters
  • project (String)
  • database (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#field_path

def field_path(project:, database:, collection:, field:) -> ::String

Create a fully-qualified Field resource string.

The resource will be in the following format:

projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}

Parameters
  • project (String)
  • database (String)
  • collection (String)
  • field (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#index_path

def index_path(project:, database:, collection:, index:) -> ::String

Create a fully-qualified Index resource string.

The resource will be in the following format:

projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}

Parameters
  • project (String)
  • database (String)
  • collection (String)
  • index (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#location_path

def location_path(project:, location:) -> ::String

Create a fully-qualified Location resource string.

The resource will be in the following format:

projects/{project}/locations/{location}

Parameters
  • project (String)
  • location (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#operation_path

def operation_path(project:, database:, operation:) -> ::String

Create a fully-qualified Operation resource string.

The resource will be in the following format:

projects/{project}/databases/{database}/operations/{operation}

Parameters
  • project (String)
  • database (String)
  • operation (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#project_path

def project_path(project:) -> ::String

Create a fully-qualified Project resource string.

The resource will be in the following format:

projects/{project}

Parameter
  • project (String)
Returns
  • (::String)

#user_creds_path

def user_creds_path(project:, database:, user_creds:) -> ::String

Create a fully-qualified UserCreds resource string.

The resource will be in the following format:

projects/{project}/databases/{database}/userCreds/{user_creds}

Parameters
  • project (String)
  • database (String)
  • user_creds (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)