Docs Support Console
    Contact Us Start free

    Class /GOOG/CL_BATCH_V1

    Class

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

    Types

    Type Description Visibility
    TY_001
    		Accelerator PUBLIC
    TY_002
    		ActionCondition PUBLIC
    TY_003
    		AgentContainer PUBLIC
    TY_004
    		AgentEnvironment PUBLIC
    TY_005
    		AgentInfo PUBLIC
    TY_006
    		AgentKMSEnvMap PUBLIC
    TY_007
    		AgentMetadata PUBLIC
    TY_008
    		AgentScript PUBLIC
    TY_009
    		AgentTask PUBLIC
    TY_010
    		AgentTaskInfo PUBLIC
    TY_011
    		AgentTaskRunnable PUBLIC
    TY_012
    		AgentTaskSpec PUBLIC
    TY_013
    		AgentTimingInfo PUBLIC
    TY_014
    		AllocationPolicy PUBLIC
    TY_015
    		AttachedDisk PUBLIC
    TY_016
    		Barrier PUBLIC
    TY_018
    		ComputeResource PUBLIC
    TY_019
    		Container PUBLIC
    TY_020
    		Disk PUBLIC
    TY_022
    		Environment PUBLIC
    TY_023
    		GCS PUBLIC
    TY_024
    		InstancePolicy PUBLIC
    TY_025
    		InstancePolicyOrTemplate PUBLIC
    TY_026
    		InstanceStatus PUBLIC
    TY_027
    		Job PUBLIC
    TY_028
    		JobNotification PUBLIC
    TY_029
    		JobStatus PUBLIC
    TY_030
    		KMSEnvMap PUBLIC
    TY_031
    		LifecyclePolicy PUBLIC
    TY_032
    		ListJobsResponse PUBLIC
    TY_033
    		ListLocationsResponse PUBLIC
    TY_034
    		ListOperationsResponse PUBLIC
    TY_035
    		ListTasksResponse PUBLIC
    TY_036
    		Location PUBLIC
    TY_037
    		LocationPolicy PUBLIC
    TY_038
    		LogsPolicy PUBLIC
    TY_039
    		Message PUBLIC
    TY_040
    		NFS PUBLIC
    TY_041
    		NetworkInterface PUBLIC
    TY_042
    		NetworkPolicy PUBLIC
    TY_043
    		Operation PUBLIC
    TY_044
    		PlacementPolicy PUBLIC
    TY_045
    		ReportAgentStateRequest PUBLIC
    TY_046
    		ReportAgentStateResponse PUBLIC
    TY_047
    		Runnable PUBLIC
    TY_048
    		Script PUBLIC
    TY_049
    		ServiceAccount PUBLIC
    TY_050
    		Status PUBLIC
    TY_051
    		StatusEvent PUBLIC
    TY_052
    		Task PUBLIC
    TY_053
    		TaskExecution PUBLIC
    TY_054
    		TaskGroup PUBLIC
    TY_055
    		TaskGroupStatus PUBLIC
    TY_056
    		TaskSpec PUBLIC
    TY_057
    		TaskStatus PUBLIC
    TY_058
    		Volume PUBLIC
    TY_059
    		AgentTaskUserAccount PUBLIC
    TY_060
    		CloudLoggingOption PUBLIC
    TY_061
    		AgentTaskLoggingOption PUBLIC
    TY_062
    		CancelJobRequest PUBLIC
    TY_T_001
    		Accelerator PUBLIC
    TY_T_009
    		AgentTask PUBLIC
    TY_T_010
    		AgentTaskInfo PUBLIC
    TY_T_011
    		AgentTaskRunnable PUBLIC
    TY_T_015
    		AttachedDisk PUBLIC
    TY_T_022
    		Environment PUBLIC
    TY_T_025
    		InstancePolicyOrTemplate PUBLIC
    TY_T_026
    		InstanceStatus PUBLIC
    TY_T_027
    		Job PUBLIC
    TY_T_028
    		JobNotification PUBLIC
    TY_T_031
    		LifecyclePolicy PUBLIC
    TY_T_036
    		Location PUBLIC
    TY_T_041
    		NetworkInterface PUBLIC
    TY_T_043
    		Operation PUBLIC
    TY_T_047
    		Runnable PUBLIC
    TY_T_051
    		StatusEvent PUBLIC
    TY_T_052
    		Task PUBLIC
    TY_T_054
    		TaskGroup PUBLIC
    TY_T_058
    		Volume PUBLIC
    TY_T_INT4
    		Table of Integers PUBLIC
    TY_T_STRING
    		Table of Strings PUBLIC

    Constants

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

    CANCEL_JOBS

    • Description: batch.projects.locations.jobs.cancel
    • Visibility: PUBLIC

    Parameters

    Name Category Type Description
    IV_P_PROJECTS_ID
    		IMPORTING STRING projectsId
    IV_P_LOCATIONS_ID
    		IMPORTING STRING locationsId
    IV_P_JOBS_ID
    		IMPORTING STRING jobsId
    IS_INPUT
    		IMPORTING TY_062 CancelJobRequest
    ES_RAW
    		EXPORTING DATA Raw Output Data
    ES_OUTPUT
    		EXPORTING TY_043 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

    CANCEL_OPERATIONS

    • Description: batch.projects.locations.operations.cancel
    • Visibility: PUBLIC

    Parameters

    Name Category Type Description
    IV_P_PROJECTS_ID
    		IMPORTING STRING projectsId
    IV_P_LOCATIONS_ID
    		IMPORTING STRING locationsId
    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

    CREATE_JOBS

    • Description: batch.projects.locations.jobs.create
    • Visibility: PUBLIC

    Parameters

    Name Category Type Description
    IV_Q_JOBID
    		IMPORTING STRING jobId
    IV_Q_REQUESTID
    		IMPORTING STRING requestId
    IV_P_PROJECTS_ID
    		IMPORTING STRING projectsId
    IV_P_LOCATIONS_ID
    		IMPORTING STRING locationsId
    IS_INPUT
    		IMPORTING TY_027 Job
    ES_RAW
    		EXPORTING DATA Raw Output Data
    ES_OUTPUT
    		EXPORTING TY_027 Job
    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_JOBS

    • Description: batch.projects.locations.jobs.delete
    • Visibility: PUBLIC

    Parameters

    Name Category Type Description
    IV_Q_REASON
    		IMPORTING STRING reason
    IV_Q_REQUESTID
    		IMPORTING STRING requestId
    IV_P_PROJECTS_ID
    		IMPORTING STRING projectsId
    IV_P_LOCATIONS_ID
    		IMPORTING STRING locationsId
    IV_P_JOBS_ID
    		IMPORTING STRING jobsId
    ES_RAW
    		EXPORTING DATA Raw Output Data
    ES_OUTPUT
    		EXPORTING TY_043 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_OPERATIONS

    • Description: batch.projects.locations.operations.delete
    • Visibility: PUBLIC

    Parameters

    Name Category Type Description
    IV_P_PROJECTS_ID
    		IMPORTING STRING projectsId
    IV_P_LOCATIONS_ID
    		IMPORTING STRING locationsId
    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

    GET_JOBS

    • Description: batch.projects.locations.jobs.get
    • Visibility: PUBLIC

    Parameters

    Name Category Type Description
    IV_P_PROJECTS_ID
    		IMPORTING STRING projectsId
    IV_P_LOCATIONS_ID
    		IMPORTING STRING locationsId
    IV_P_JOBS_ID
    		IMPORTING STRING jobsId
    ES_RAW
    		EXPORTING DATA Raw Output Data
    ES_OUTPUT
    		EXPORTING TY_027 Job
    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: batch.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_036 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: batch.projects.locations.operations.get
    • Visibility: PUBLIC

    Parameters

    Name Category Type Description
    IV_P_PROJECTS_ID
    		IMPORTING STRING projectsId
    IV_P_LOCATIONS_ID
    		IMPORTING STRING locationsId
    IV_P_OPERATIONS_ID
    		IMPORTING STRING operationsId
    ES_RAW
    		EXPORTING DATA Raw Output Data
    ES_OUTPUT
    		EXPORTING TY_043 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_TASKS

    • Description: batch.projects.locations.jobs.taskGroups.tasks.get
    • Visibility: PUBLIC

    Parameters

    Name Category Type Description
    IV_P_PROJECTS_ID
    		IMPORTING STRING projectsId
    IV_P_LOCATIONS_ID
    		IMPORTING STRING locationsId
    IV_P_JOBS_ID
    		IMPORTING STRING jobsId
    IV_P_TASK_GROUPS_ID
    		IMPORTING STRING taskGroupsId
    IV_P_TASKS_ID
    		IMPORTING STRING tasksId
    ES_RAW
    		EXPORTING DATA Raw Output Data
    ES_OUTPUT
    		EXPORTING TY_052 Task
    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_JOBS

    • Description: batch.projects.locations.jobs.list
    • Visibility: PUBLIC

    Parameters

    Name Category Type Description
    IV_Q_FILTER
    		IMPORTING STRING filter
    IV_Q_ORDERBY
    		IMPORTING STRING orderBy
    IV_Q_PAGESIZE
    		IMPORTING STRING pageSize
    IV_Q_PAGETOKEN
    		IMPORTING STRING pageToken
    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_032 ListJobsResponse
    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: batch.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_033 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: batch.projects.locations.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_LOCATIONS_ID
    		IMPORTING STRING locationsId
    ES_RAW
    		EXPORTING DATA Raw Output Data
    ES_OUTPUT
    		EXPORTING TY_034 ListOperationsResponse
    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_TASKS

    • Description: batch.projects.locations.jobs.taskGroups.tasks.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_LOCATIONS_ID
    		IMPORTING STRING locationsId
    IV_P_JOBS_ID
    		IMPORTING STRING jobsId
    IV_P_TASK_GROUPS_ID
    		IMPORTING STRING taskGroupsId
    ES_RAW
    		EXPORTING DATA Raw Output Data
    ES_OUTPUT
    		EXPORTING TY_035 ListTasksResponse
    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

    REPORT_STATE

    • Description: batch.projects.locations.state.report
    • Visibility: PUBLIC

    Parameters

    Name Category Type Description
    IV_P_PROJECTS_ID
    		IMPORTING STRING projectsId
    IV_P_LOCATIONS_ID
    		IMPORTING STRING locationsId
    IS_INPUT
    		IMPORTING TY_045 ReportAgentStateRequest
    ES_RAW
    		EXPORTING DATA Raw Output Data
    ES_OUTPUT
    		EXPORTING TY_046 ReportAgentStateResponse
    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
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: