Class /GOOG/CL_FIRESTORE_V1BETA2

Class

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

Types

Type Description Visibility
TY_003 GoogleFirestoreAdminV1beta2ExportDocumentsRequest PUBLIC
TY_004 GoogleFirestoreAdminV1beta2Field PUBLIC
TY_005 GoogleFirestoreAdminV1beta2ImportDocumentsRequest PUBLIC
TY_006 GoogleFirestoreAdminV1beta2Index PUBLIC
TY_007 GoogleFirestoreAdminV1beta2IndexConfig PUBLIC
TY_009 GoogleFirestoreAdminV1beta2IndexField PUBLIC
TY_010 GoogleFirestoreAdminV1beta2ListFieldsResponse PUBLIC
TY_011 GoogleFirestoreAdminV1beta2ListIndexesResponse PUBLIC
TY_013 GoogleLongrunningOperation PUBLIC
TY_014 Status PUBLIC
TY_T_004 GoogleFirestoreAdminV1beta2Field PUBLIC
TY_T_006 GoogleFirestoreAdminV1beta2Index PUBLIC
TY_T_009 GoogleFirestoreAdminV1beta2IndexField PUBLIC
TY_T_STRING Table of Strings PUBLIC

Constants

Name Type Description Value Visibility
C_SUPPORTED_AUTH /GOOG/SUPP_AUTH Supported Auth Types IJIJWW PUBLIC
C_SERVICE_NAME /GOOG/SERVICE_NAME Google Service Name firestore:v1beta2 PUBLIC
C_ROOT_URL STRING API Root URL https://firestore.googleapis.com PUBLIC
C_REVISION_DATE DATUM Discovery Document revision Date 20250226 PUBLIC
C_PATH_PREFIX STRING API Path Prefix PUBLIC
C_ON_PREM_VERSION /GOOG/SDK_VERSION Lowest On-premises Version 1.7 PUBLIC
C_CLOUD_VERSION /GOOG/SDK_VERSION Lowest Cloud Version 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

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_006 GoogleFirestoreAdminV1beta2Index
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_013 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_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

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_003 GoogleFirestoreAdminV1beta2ExportDocumentsRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_013 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_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_004 GoogleFirestoreAdminV1beta2Field
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_006 GoogleFirestoreAdminV1beta2Index
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_005 GoogleFirestoreAdminV1beta2ImportDocumentsRequest
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_013 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

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_010 GoogleFirestoreAdminV1beta2ListFieldsResponse
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_011 GoogleFirestoreAdminV1beta2ListIndexesResponse
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_004 GoogleFirestoreAdminV1beta2Field
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_013 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

CLOSE

  • Description: Close Connection
  • Visibility: PUBLIC