Class /GOOG/CL_APIKEYS_V2

Class

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

Types

Type Description Visibility
TY_001 Operation PUBLIC
TY_002 Status PUBLIC
TY_003 V2AndroidApplication PUBLIC
TY_004 V2AndroidKeyRestrictions PUBLIC
TY_005 V2ApiTarget PUBLIC
TY_006 V2BrowserKeyRestrictions PUBLIC
TY_007 V2GetKeyStringResponse PUBLIC
TY_008 V2IosKeyRestrictions PUBLIC
TY_009 V2Key PUBLIC
TY_010 V2ListKeysResponse PUBLIC
TY_011 V2LookupKeyResponse PUBLIC
TY_012 V2Restrictions PUBLIC
TY_013 V2ServerKeyRestrictions PUBLIC
TY_T_003 V2AndroidApplication PUBLIC
TY_T_005 V2ApiTarget PUBLIC
TY_T_009 V2Key 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 apikeys:v2 PUBLIC
C_ROOT_URL STRING API Root URL https://apikeys.googleapis.com PUBLIC
C_REVISION_DATE DATUM Discovery Document revision Date 20241115 PUBLIC
C_PATH_PREFIX STRING API Path Prefix PUBLIC
C_ON_PREM_VERSION /GOOG/SDK_VERSION Lowest On-premises Version 1.5 PUBLIC
C_CLOUD_VERSION /GOOG/SDK_VERSION Lowest Cloud Version 1.0 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_KEYS

  • Description: apikeys.projects.locations.keys.create
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_KEYID IMPORTING STRING keyId
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_LOCATIONS_ID IMPORTING STRING locationsId
IS_INPUT IMPORTING TY_009 V2Key
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_001 Operation
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_KEYS

  • Description: apikeys.projects.locations.keys.delete
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_ETAG IMPORTING STRING etag
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_LOCATIONS_ID IMPORTING STRING locationsId
IV_P_KEYS_ID IMPORTING STRING keysId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_001 Operation
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_KEYS

  • Description: apikeys.projects.locations.keys.get
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_LOCATIONS_ID IMPORTING STRING locationsId
IV_P_KEYS_ID IMPORTING STRING keysId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_009 V2Key
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_KEY_STRING_KEYS

  • Description: apikeys.projects.locations.keys.getKeyString
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_LOCATIONS_ID IMPORTING STRING locationsId
IV_P_KEYS_ID IMPORTING STRING keysId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_007 V2GetKeyStringResponse
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: apikeys.operations.get
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_OPERATIONS_ID IMPORTING STRING operationsId
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_001 Operation
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_KEYS

  • Description: apikeys.projects.locations.keys.list
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_PAGESIZE IMPORTING STRING pageSize
IV_Q_PAGETOKEN IMPORTING STRING pageToken
IV_Q_SHOWDELETED IMPORTING STRING showDeleted
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_010 V2ListKeysResponse
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

LOOKUP_KEY_KEYS

  • Description: apikeys.keys.lookupKey
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_KEYSTRING IMPORTING STRING keyString
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_011 V2LookupKeyResponse
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_KEYS

  • Description: apikeys.projects.locations.keys.patch
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_Q_UPDATEMASK IMPORTING STRING updateMask
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_LOCATIONS_ID IMPORTING STRING locationsId
IV_P_KEYS_ID IMPORTING STRING keysId
IS_INPUT IMPORTING TY_009 V2Key
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_001 Operation
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

UNDELETE_KEYS

  • Description: apikeys.projects.locations.keys.undelete
  • Visibility: PUBLIC

Parameters

Name Category Type Description
IV_P_PROJECTS_ID IMPORTING STRING projectsId
IV_P_LOCATIONS_ID IMPORTING STRING locationsId
IV_P_KEYS_ID IMPORTING STRING keysId
IS_INPUT IMPORTING DATA Input Data
ES_RAW EXPORTING DATA Raw Output Data
ES_OUTPUT EXPORTING TY_001 Operation
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