Skip to content

Latest commit

 

History

History
56 lines (50 loc) · 4.17 KB

BulkRequest.md

File metadata and controls

56 lines (50 loc) · 4.17 KB

IntersightClient::BulkRequest

Properties

Name Type Description Notes
class_id String The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data. [default to 'bulk.Request']
object_type String The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property. [default to 'bulk.Request']
action_on_error String The action to be taken when an error occurs during processing of the request. * `Stop` - Stop the processing of the request after the first error. * `Proceed` - Proceed with the processing of the request even when an error occurs. [optional][default to 'Stop']
actions Array<String> [optional]
completion_time String The timestamp when the request processing completed. [optional][readonly]
headers Array<BulkHttpHeader> [optional]
num_sub_requests Integer The number of sub requests received in this request. [optional][readonly]
org_moid String The moid of the organization under which this request was issued. [optional][readonly]
request_received_time String The timestamp when the request was received. [optional][readonly]
requests Array<BulkSubRequest> [optional]
results Array<BulkApiResult> [optional]
skip_duplicates Boolean Skip the already present objects. [optional]
status String The processing status of the Request. * `NotStarted` - Indicates that the request processing has not begun yet. * `ObjPresenceCheckInProgress` - Indicates that the object presence check is in progress for this request. * `ObjPresenceCheckComplete` - Indicates that the object presence check is complete. * `ExecutionInProgress` - Indicates that the request processing is in progress. * `Completed` - Indicates that the request processing has been completed successfully. * `Failed` - Indicates that the processing of this request failed. [optional][readonly][default to 'NotStarted']
status_message String The status message corresponding to the status. [optional][readonly]
uri String The URI on which this bulk action is to be performed. The value will be used when there is no override in the SubRequest. [optional]
verb String The type of operation to be performed. One of - Post (Create), Patch (Update) or Delete (Remove). The value will be used when there is no override in the SubRequest. * `POST` - Used to create a REST resource. * `PATCH` - Used to update a REST resource. * `DELETE` - Used to delete a REST resource. [optional][default to 'POST']
async_results Array<BulkSubRequestObjRelationship> An array of relationships to bulkSubRequestObj resources. [optional][readonly]
async_results_failed Array<BulkSubRequestObjRelationship> An array of relationships to bulkSubRequestObj resources. [optional][readonly]
organization OrganizationOrganizationRelationship [optional]
workflow_info WorkflowWorkflowInfoRelationship [optional]

Example

require 'intersight_client'

instance = IntersightClient::BulkRequest.new(
  class_id: null,
  object_type: null,
  action_on_error: null,
  actions: null,
  completion_time: null,
  headers: null,
  num_sub_requests: null,
  org_moid: null,
  request_received_time: null,
  requests: null,
  results: null,
  skip_duplicates: null,
  status: null,
  status_message: null,
  uri: null,
  verb: null,
  async_results: null,
  async_results_failed: null,
  organization: null,
  workflow_info: null
)