Class /GOOG/CL_FIRESTORE_V1

Class

/GOOG/CL_FIRESTORE_V1
  • Inheriting from:/GOOG/CL_HTTP_CLIENT
  • Description:Cloud Firestore API v1
For general information about a class in ABAP SDK for Google Cloud, see API client stub.

Types

Type Description Visibility
TY_001 Aggregation PUBLIC
TY_002 AggregationResult PUBLIC
TY_004 BatchGetDocumentsRequest PUBLIC
TY_005 BatchGetDocumentsResponse PUBLIC
TY_006 BatchWriteRequest PUBLIC
TY_007 BatchWriteResponse PUBLIC
TY_008 BeginTransactionRequest PUBLIC
TY_009 BeginTransactionResponse PUBLIC
TY_010 BitSequence PUBLIC
TY_011 BloomFilter PUBLIC
TY_012 CollectionSelector PUBLIC
TY_013 CommitRequest PUBLIC
TY_014 CommitResponse PUBLIC
TY_016 Count PUBLIC
TY_017 Cursor PUBLIC
TY_018 Document PUBLIC
TY_019 DocumentChange PUBLIC
TY_020 DocumentDelete PUBLIC
TY_021 DocumentMask PUBLIC
TY_022 DocumentRemove PUBLIC
TY_023 DocumentTransform PUBLIC
TY_024 DocumentsTarget PUBLIC
TY_026 ExistenceFilter PUBLIC
TY_028 FieldReference PUBLIC
TY_029 FieldTransform PUBLIC
TY_031 GoogleFirestoreAdminV1Backup PUBLIC
TY_032 GoogleFirestoreAdminV1BackupSchedule PUBLIC
TY_034 GoogleFirestoreAdminV1Database PUBLIC
TY_035 GoogleFirestoreAdminV1ExportDocumentsRequest PUBLIC
TY_036 GoogleFirestoreAdminV1Field PUBLIC
TY_037 GoogleFirestoreAdminV1ImportDocumentsRequest PUBLIC
TY_038 GoogleFirestoreAdminV1Index PUBLIC
TY_039 GoogleFirestoreAdminV1IndexConfig PUBLIC
TY_041 GoogleFirestoreAdminV1IndexField PUBLIC
TY_042 GoogleFirestoreAdminV1ListBackupSchedulesResponse PUBLIC
TY_043 GoogleFirestoreAdminV1ListBackupsResponse PUBLIC
TY_044 GoogleFirestoreAdminV1ListDatabasesResponse PUBLIC
TY_045 GoogleFirestoreAdminV1ListFieldsResponse PUBLIC
TY_046 GoogleFirestoreAdminV1ListIndexesResponse PUBLIC
TY_048 GoogleFirestoreAdminV1RestoreDatabaseRequest PUBLIC
TY_049 GoogleFirestoreAdminV1Stats PUBLIC
TY_050 GoogleFirestoreAdminV1TtlConfig PUBLIC
TY_052 GoogleFirestoreAdminV1WeeklyRecurrence PUBLIC
TY_054 GoogleLongrunningListOperationsResponse PUBLIC
TY_055 GoogleLongrunningOperation PUBLIC
TY_056 LatLng PUBLIC
TY_057 ListCollectionIdsRequest PUBLIC
TY_058 ListCollectionIdsResponse PUBLIC
TY_059 ListDocumentsResponse PUBLIC
TY_060 ListLocationsResponse PUBLIC
TY_061 ListenRequest PUBLIC
TY_062 ListenResponse PUBLIC
TY_063 Location PUBLIC
TY_064 MapValue PUBLIC
TY_065 Order PUBLIC
TY_066 PartitionQueryRequest PUBLIC
TY_067 PartitionQueryResponse PUBLIC
TY_068 Precondition PUBLIC
TY_069 Projection PUBLIC
TY_070 QueryTarget PUBLIC
TY_071 ReadOnly PUBLIC
TY_072 ReadWrite PUBLIC
TY_073 RollbackRequest PUBLIC
TY_074 RunAggregationQueryRequest PUBLIC
TY_075 RunAggregationQueryResponse PUBLIC
TY_076 RunQueryRequest PUBLIC
TY_077 RunQueryResponse PUBLIC
TY_078 Status PUBLIC
TY_079 StructuredAggregationQuery PUBLIC
TY_080 StructuredQuery PUBLIC
TY_081 Target PUBLIC
TY_082 TargetChange PUBLIC
TY_083 TransactionOptions PUBLIC
TY_085 Value PUBLIC
TY_086 Write PUBLIC
TY_087 WriteRequest PUBLIC
TY_088 WriteResponse PUBLIC
TY_089 WriteResult PUBLIC
TY_090 Avg PUBLIC
TY_091 Sum PUBLIC
TY_092 ExecutionStats PUBLIC
TY_093 ExplainMetrics PUBLIC
TY_094 ExplainOptions PUBLIC
TY_095 FindNearest PUBLIC
TY_096 GoogleFirestoreAdminV1CmekConfig PUBLIC
TY_099 GoogleFirestoreAdminV1VectorConfig PUBLIC
TY_100 PlanSummary PUBLIC
TY_102 GoogleFirestoreAdminV1BackupSource PUBLIC
TY_103 GoogleFirestoreAdminV1BulkDeleteDocumentsRequest PUBLIC
TY_104 GoogleFirestoreAdminV1CustomerManagedEncryptionOptions PUBLIC
TY_105 GoogleFirestoreAdminV1EncryptionConfig PUBLIC
TY_108 GoogleFirestoreAdminV1SourceInfo PUBLIC
TY_T_001 Aggregation PUBLIC
TY_T_012 CollectionSelector PUBLIC
TY_T_017 Cursor PUBLIC
TY_T_018 Document PUBLIC
TY_T_028 FieldReference PUBLIC
TY_T_029 FieldTransform PUBLIC
TY_T_031 GoogleFirestoreAdminV1Backup PUBLIC
TY_T_032 GoogleFirestoreAdminV1BackupSchedule PUBLIC
TY_T_034 GoogleFirestoreAdminV1Database PUBLIC
TY_T_036 GoogleFirestoreAdminV1Field PUBLIC
TY_T_038 GoogleFirestoreAdminV1Index PUBLIC
TY_T_041 GoogleFirestoreAdminV1IndexField PUBLIC
TY_T_055 GoogleLongrunningOperation PUBLIC
TY_T_063 Location PUBLIC
TY_T_065 Order PUBLIC
TY_T_078 Status PUBLIC
TY_T_085 Value PUBLIC
TY_T_086 Write PUBLIC
TY_T_089 WriteResult PUBLIC
TY_T_INT4 Table of Integers PUBLIC
TY_T_STRING Table of Strings PUBLIC

Constants

Name Type Description Value Visibility
C_ROOT_URL STRING API Root URL https://firestore.googleapis.com PUBLIC
C_SERVICE_NAME /GOOG/SERVICE_NAME Google Service Name firestore:v1 PUBLIC
C_SUPPORTED_AUTH /GOOG/SUPP_AUTH Supported Auth Types PUBLIC
C_REVISION_DATE DATUM Discovery Document revision Date 20241106 PUBLIC
C_PATH_PREFIX STRING API Path Prefix PUBLIC
C_ON_PREM_VERSION /GOOG/SDK_VERSION Lowest On-premises Version PUBLIC
C_CLOUD_VERSION /GOOG/SDK_VERSION Lowest Cloud Version 1.1 PUBLIC

Methods

For general information about a method in ABAP SDK for Google Cloud, see API method.

CONSTRUCTOR

  • Description: Constructor
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_KEY_NAME IMPORTING /GOOG/KEYNAME Google Cloud Key Name
IV_LOG_OBJ IMPORTING BALOBJ_D Application log: Object name (Application code)
IV_LOG_SUBOBJ IMPORTING BALSUBOBJ Application Log: Subobject

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

BATCH_GET_DOCUMENTS

  • Description: firestore.projects.databases.documents.batchGet
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IS_INPUT IMPORTING TY_004 BatchGetDocumentsRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_005 BatchGetDocumentsResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

BATCH_WRITE_DOCUMENTS

  • Description: firestore.projects.databases.documents.batchWrite
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IS_INPUT IMPORTING TY_006 BatchWriteRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_007 BatchWriteResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

BEGIN_TRANSACTION_DOCUMENTS

  • Description: firestore.projects.databases.documents.beginTransaction
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IS_INPUT IMPORTING TY_008 BeginTransactionRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_009 BeginTransactionResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

BULK_DELETE_DOCUMENTS_DATAB

  • Description: firestore.projects.databases.bulkDeleteDocuments
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IS_INPUT IMPORTING TY_103 GoogleFirestoreAdminV1BulkDeleteDocumentsRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_055 GoogleLongrunningOperation
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

CANCEL_OPERATIONS

  • Description: firestore.projects.databases.operations.cancel
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_OPERATIONS_ID IMPORTING STRING operationsId
IS_INPUT IMPORTING DATA Input Data
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING DATA Output Data
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

COMMIT_DOCUMENTS

  • Description: firestore.projects.databases.documents.commit
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IS_INPUT IMPORTING TY_013 CommitRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_014 CommitResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

CREATE_BACKUP_SCHEDULES

  • Description: firestore.projects.databases.backupSchedules.create
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IS_INPUT IMPORTING TY_032 GoogleFirestoreAdminV1BackupSchedule
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_032 GoogleFirestoreAdminV1BackupSchedule
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

CREATE_DATABASES

  • Description: firestore.projects.databases.create
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_DATABASEID IMPORTING STRING databaseId
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IS_INPUT IMPORTING TY_034 GoogleFirestoreAdminV1Database
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_055 GoogleLongrunningOperation
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

CREATE_DOCUMENT_DOCUMENTS

  • Description: firestore.projects.databases.documents.createDocument
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_DOCUMENTID IMPORTING STRING documentId
IV_Q_MASKFIELDPATHS IMPORTING STRING mask.fieldPaths
IV_P_COLLECTION_ID IMPORTING STRING collectionId
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_DOCUMENTS_ID IMPORTING STRING documentsId
IS_INPUT IMPORTING TY_018 Document
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_018 Document
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

CREATE_INDEXES

  • Description: projects.databases.collectionGroups.indexes.create
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_COLLECTION_GROUPS_ID IMPORTING STRING collectionGroupsId
IS_INPUT IMPORTING TY_038 GoogleFirestoreAdminV1Index
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_055 GoogleLongrunningOperation
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

DELETE_BACKUPS

  • Description: firestore.projects.locations.backups.delete
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_LOCATIONS_ID IMPORTING STRING locationsId
IV_P_BACKUPS_ID IMPORTING STRING backupsId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING DATA Output Data
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

DELETE_BACKUP_SCHEDULES

  • Description: firestore.projects.databases.backupSchedules.delete
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_BACKUP_SCHEDULES_ID IMPORTING STRING backupSchedulesId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING DATA Output Data
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

DELETE_DATABASES

  • Description: firestore.projects.databases.delete
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_ETAG IMPORTING STRING etag
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_055 GoogleLongrunningOperation
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

DELETE_DOCUMENTS

  • Description: firestore.projects.databases.documents.delete
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_CURRENTDOCUMENTEXISTS IMPORTING STRING currentDocument.exists
IV_Q_CURRENTDOCUMENTUPDATETIME IMPORTING STRING currentDocument.updateTime
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_DOCUMENTS_ID IMPORTING STRING documentsId
IV_P_DOCUMENTS_ID1 IMPORTING STRING documentsId1
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING DATA Output Data
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

DELETE_INDEXES

  • Description: projects.databases.collectionGroups.indexes.delete
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_COLLECTION_GROUPS_ID IMPORTING STRING collectionGroupsId
IV_P_INDEXES_ID IMPORTING STRING indexesId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING DATA Output Data
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

DELETE_OPERATIONS

  • Description: firestore.projects.databases.operations.delete
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_OPERATIONS_ID IMPORTING STRING operationsId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING DATA Output Data
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

EXPORT_DOCUMENTS_DATABASES

  • Description: firestore.projects.databases.exportDocuments
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IS_INPUT IMPORTING TY_035 GoogleFirestoreAdminV1ExportDocumentsRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_055 GoogleLongrunningOperation
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

GET_BACKUPS

  • Description: firestore.projects.locations.backups.get
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_LOCATIONS_ID IMPORTING STRING locationsId
IV_P_BACKUPS_ID IMPORTING STRING backupsId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_031 GoogleFirestoreAdminV1Backup
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

GET_BACKUP_SCHEDULES

  • Description: firestore.projects.databases.backupSchedules.get
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_BACKUP_SCHEDULES_ID IMPORTING STRING backupSchedulesId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_032 GoogleFirestoreAdminV1BackupSchedule
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

GET_DATABASES

  • Description: firestore.projects.databases.get
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_034 GoogleFirestoreAdminV1Database
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

GET_DOCUMENTS

  • Description: firestore.projects.databases.documents.get
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_MASKFIELDPATHS IMPORTING STRING mask.fieldPaths
IV_Q_READTIME IMPORTING STRING readTime
IV_Q_TRANSACTION IMPORTING STRING transaction
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_DOCUMENTS_ID IMPORTING STRING documentsId
IV_P_DOCUMENTS_ID1 IMPORTING STRING documentsId1
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_018 Document
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

GET_FIELDS

  • Description: firestore.projects.databases.collectionGroups.fields.get
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_COLLECTION_GROUPS_ID IMPORTING STRING collectionGroupsId
IV_P_FIELDS_ID IMPORTING STRING fieldsId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_036 GoogleFirestoreAdminV1Field
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

GET_INDEXES

  • Description: firestore.projects.databases.collectionGroups.indexes.get
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_COLLECTION_GROUPS_ID IMPORTING STRING collectionGroupsId
IV_P_INDEXES_ID IMPORTING STRING indexesId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_038 GoogleFirestoreAdminV1Index
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

GET_LOCATIONS

  • Description: firestore.projects.locations.get
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_LOCATIONS_ID IMPORTING STRING locationsId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_063 Location
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

GET_OPERATIONS

  • Description: firestore.projects.databases.operations.get
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_OPERATIONS_ID IMPORTING STRING operationsId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_055 GoogleLongrunningOperation
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

IMPORT_DOCUMENTS_DATABASES

  • Description: firestore.projects.databases.importDocuments
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IS_INPUT IMPORTING TY_037 GoogleFirestoreAdminV1ImportDocumentsRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_055 GoogleLongrunningOperation
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

LISTEN_DOCUMENTS

  • Description: firestore.projects.databases.documents.listen
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IS_INPUT IMPORTING TY_061 ListenRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_062 ListenResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

LIST_BACKUPS

  • Description: firestore.projects.locations.backups.list
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_FILTER IMPORTING STRING filter
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_LOCATIONS_ID IMPORTING STRING locationsId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_043 GoogleFirestoreAdminV1ListBackupsResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

LIST_BACKUP_SCHEDULES

  • Description: firestore.projects.databases.backupSchedules.list
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_042 GoogleFirestoreAdminV1ListBackupSchedulesResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

LIST_COLLECTION_IDS_DOCUMEN

  • Description: firestore.projects.databases.documents.listCollectionIds
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_DOCUMENTS_ID IMPORTING STRING documentsId
IV_P_DOCUMENTS_ID1 IMPORTING STRING documentsId1
IS_INPUT IMPORTING TY_057 ListCollectionIdsRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_058 ListCollectionIdsResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

LIST_DATABASES

  • Description: firestore.projects.databases.list
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_SHOWDELETED IMPORTING STRING showDeleted
IV_P_PROJECTS_ID IMPORTING STRING projectsId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_044 GoogleFirestoreAdminV1ListDatabasesResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

LIST_DOCUMENTS

  • Description: firestore.projects.databases.documents.list
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_MASKFIELDPATHS IMPORTING STRING mask.fieldPaths
IV_Q_ORDERBY IMPORTING STRING orderBy
IV_Q_PAGESIZE IMPORTING STRING pageSize
IV_Q_PAGETOKEN IMPORTING STRING pageToken
IV_Q_READTIME IMPORTING STRING readTime
IV_Q_SHOWMISSING IMPORTING STRING showMissing
IV_Q_TRANSACTION IMPORTING STRING transaction
IV_P_COLLECTION_ID IMPORTING STRING collectionId
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_DOCUMENTS_ID IMPORTING STRING documentsId
IV_P_DOCUMENTS_ID1 IMPORTING STRING documentsId1
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_059 ListDocumentsResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

LIST_DOCUMENTS_DOCUMENTS

  • Description: firestore.projects.databases.documents.listDocuments
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_MASKFIELDPATHS IMPORTING STRING mask.fieldPaths
IV_Q_ORDERBY IMPORTING STRING orderBy
IV_Q_PAGESIZE IMPORTING STRING pageSize
IV_Q_PAGETOKEN IMPORTING STRING pageToken
IV_Q_READTIME IMPORTING STRING readTime
IV_Q_SHOWMISSING IMPORTING STRING showMissing
IV_Q_TRANSACTION IMPORTING STRING transaction
IV_P_COLLECTION_ID IMPORTING STRING collectionId
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_059 ListDocumentsResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

LIST_FIELDS

  • Description: firestore.projects.databases.collectionGroups.fields.list
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_FILTER IMPORTING STRING filter
IV_Q_PAGESIZE IMPORTING STRING pageSize
IV_Q_PAGETOKEN IMPORTING STRING pageToken
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_COLLECTION_GROUPS_ID IMPORTING STRING collectionGroupsId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_045 GoogleFirestoreAdminV1ListFieldsResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

LIST_INDEXES

  • Description: firestore.projects.databases.collectionGroups.indexes.list
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_FILTER IMPORTING STRING filter
IV_Q_PAGESIZE IMPORTING STRING pageSize
IV_Q_PAGETOKEN IMPORTING STRING pageToken
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_COLLECTION_GROUPS_ID IMPORTING STRING collectionGroupsId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_046 GoogleFirestoreAdminV1ListIndexesResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

LIST_LOCATIONS

  • Description: firestore.projects.locations.list
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_FILTER IMPORTING STRING filter
IV_Q_PAGESIZE IMPORTING STRING pageSize
IV_Q_PAGETOKEN IMPORTING STRING pageToken
IV_P_PROJECTS_ID IMPORTING STRING projectsId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_060 ListLocationsResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

LIST_OPERATIONS

  • Description: firestore.projects.databases.operations.list
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_FILTER IMPORTING STRING filter
IV_Q_PAGESIZE IMPORTING STRING pageSize
IV_Q_PAGETOKEN IMPORTING STRING pageToken
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_054 GoogleLongrunningListOperationsResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

PARTITION_QUERY_DOCUMENTS

  • Description: firestore.projects.databases.documents.partitionQuery
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_DOCUMENTS_ID IMPORTING STRING documentsId
IV_P_DOCUMENTS_ID1 IMPORTING STRING documentsId1
IS_INPUT IMPORTING TY_066 PartitionQueryRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_067 PartitionQueryResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

PATCH_BACKUP_SCHEDULES

  • Description: firestore.projects.databases.backupSchedules.patch
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_UPDATEMASK IMPORTING STRING updateMask
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_BACKUP_SCHEDULES_ID IMPORTING STRING backupSchedulesId
IS_INPUT IMPORTING TY_032 GoogleFirestoreAdminV1BackupSchedule
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_032 GoogleFirestoreAdminV1BackupSchedule
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

PATCH_DATABASES

  • Description: firestore.projects.databases.patch
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_UPDATEMASK IMPORTING STRING updateMask
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IS_INPUT IMPORTING TY_034 GoogleFirestoreAdminV1Database
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_055 GoogleLongrunningOperation
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

PATCH_DOCUMENTS

  • Description: firestore.projects.databases.documents.patch
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_CURRENTDOCUMENTEXISTS IMPORTING STRING currentDocument.exists
IV_Q_CURRENTDOCUMENTUPDATETIME IMPORTING STRING currentDocument.updateTime
IV_Q_MASKFIELDPATHS IMPORTING STRING mask.fieldPaths
IV_Q_UPDATEMASKFIELDPATHS IMPORTING STRING updateMask.fieldPaths
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_DOCUMENTS_ID IMPORTING STRING documentsId
IV_P_DOCUMENTS_ID1 IMPORTING STRING documentsId1
IS_INPUT IMPORTING TY_018 Document
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_018 Document
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

PATCH_FIELDS

  • Description: firestore.projects.databases.collectionGroups.fields.patch
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_UPDATEMASK IMPORTING STRING updateMask
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_COLLECTION_GROUPS_ID IMPORTING STRING collectionGroupsId
IV_P_FIELDS_ID IMPORTING STRING fieldsId
IS_INPUT IMPORTING TY_036 GoogleFirestoreAdminV1Field
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_055 GoogleLongrunningOperation
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

RESTORE_DATABASES

  • Description: firestore.projects.databases.restore
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IS_INPUT IMPORTING TY_048 GoogleFirestoreAdminV1RestoreDatabaseRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_055 GoogleLongrunningOperation
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

ROLLBACK_DOCUMENTS

  • Description: firestore.projects.databases.documents.rollback
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IS_INPUT IMPORTING TY_073 RollbackRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING DATA Output Data
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

RUN_AGGREGATION_QUERY_DOCUM

  • Description: firestore.projects.databases.documents.runAggregationQuery
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_DOCUMENTS_ID IMPORTING STRING documentsId
IV_P_DOCUMENTS_ID1 IMPORTING STRING documentsId1
IS_INPUT IMPORTING TY_074 RunAggregationQueryRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_075 RunAggregationQueryResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

RUN_QUERY_DOCUMENTS

  • Description: firestore.projects.databases.documents.runQuery
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IV_P_DOCUMENTS_ID IMPORTING STRING documentsId
IV_P_DOCUMENTS_ID1 IMPORTING STRING documentsId1
IS_INPUT IMPORTING TY_076 RunQueryRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_077 RunQueryResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

WRITE_DOCUMENTS

  • Description: firestore.projects.databases.documents.write
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_DATABASES_ID IMPORTING STRING databasesId
IS_INPUT IMPORTING TY_087 WriteRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_088 WriteResponse
EV_RET_CODE EXPORTING I Return Code
EV_ERR_TEXT EXPORTING STRING Error Text
ES_ERR_RESP EXPORTING /GOOG/ERR_RESP Error Response

Exception

Name Description
/GOOG/CX_SDK ABAP SDK for Google Cloud: Exception Class

CLOSE

  • Description: Close Connection
  • Visibility: PUBLIC