module Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Paths

def backup_path project:, location:, backup:

Returns:
  • (::String) -

Parameters:
  • backup (String) --
  • location (String) --
  • project (String) --
def backup_path project:, location:, backup:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  "projects/#{project}/locations/#{location}/backups/#{backup}"
end

def backup_schedule_path project:, database:, backup_schedule:

Returns:
  • (::String) -

Parameters:
  • backup_schedule (String) --
  • database (String) --
  • project (String) --
def backup_schedule_path project:, database:, backup_schedule:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "database cannot contain /" if database.to_s.include? "/"
  "projects/#{project}/databases/#{database}/backupSchedules/#{backup_schedule}"
end

def collection_group_path project:, database:, collection:

Returns:
  • (::String) -

Parameters:
  • collection (String) --
  • database (String) --
  • project (String) --
def collection_group_path project:, database:, collection:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "database cannot contain /" if database.to_s.include? "/"
  "projects/#{project}/databases/#{database}/collectionGroups/#{collection}"
end

def database_path project:, database:

Returns:
  • (::String) -

Parameters:
  • database (String) --
  • project (String) --
def database_path project:, database:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  "projects/#{project}/databases/#{database}"
end

def field_path project:, database:, collection:, field:

Returns:
  • (::String) -

Parameters:
  • field (String) --
  • collection (String) --
  • database (String) --
  • project (String) --
def field_path project:, database:, collection:, field:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "database cannot contain /" if database.to_s.include? "/"
  raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
  "projects/#{project}/databases/#{database}/collectionGroups/#{collection}/fields/#{field}"
end

def index_path project:, database:, collection:, index:

Returns:
  • (::String) -

Parameters:
  • index (String) --
  • collection (String) --
  • database (String) --
  • project (String) --
def index_path project:, database:, collection:, index:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "database cannot contain /" if database.to_s.include? "/"
  raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
  "projects/#{project}/databases/#{database}/collectionGroups/#{collection}/indexes/#{index}"
end

def location_path project:, location:

Returns:
  • (::String) -

Parameters:
  • location (String) --
  • project (String) --
def location_path project:, location:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  "projects/#{project}/locations/#{location}"
end

def operation_path project:, database:, operation:

Returns:
  • (::String) -

Parameters:
  • operation (String) --
  • database (String) --
  • project (String) --
def operation_path project:, database:, operation:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "database cannot contain /" if database.to_s.include? "/"
  "projects/#{project}/databases/#{database}/operations/#{operation}"
end

def project_path project:

Returns:
  • (::String) -

Parameters:
  • project (String) --
def project_path project:
  "projects/#{project}"
end

def user_creds_path project:, database:, user_creds:

Returns:
  • (::String) -

Parameters:
  • user_creds (String) --
  • database (String) --
  • project (String) --
def user_creds_path project:, database:, user_creds:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "database cannot contain /" if database.to_s.include? "/"
  "projects/#{project}/databases/#{database}/userCreds/#{user_creds}"
end