Class: Google::Cloud::StorageBatchOperations::V1::Job

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb

Overview

The Storage Batch Operations Job description.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_list ⇒ ::Google::Cloud::StorageBatchOperations::V1::BucketList

Returns Specifies a list of buckets and their objects to be transformed.

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#complete_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time that the job was completed.

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#counters ⇒ ::Google::Cloud::StorageBatchOperations::V1::Counters (readonly)

Returns Output only. Information about the progress of the job.

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time that the job was created.

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#delete_object ⇒ ::Google::Cloud::StorageBatchOperations::V1::DeleteObject

Returns Delete objects.

Note: The following fields are mutually exclusive: delete_object, put_object_hold, put_metadata, rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::StorageBatchOperations::V1::DeleteObject) —

    Delete objects.

    Note: The following fields are mutually exclusive: delete_object, put_object_hold, put_metadata, rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#description ⇒ ::String

Returns Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.

Returns:

  • (::String) —

    Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#dry_run ⇒ ::Boolean

Returns Optional. If true, the job will run in dry run mode, returning the total object count and, if the object configuration is a prefix list, the bytes found from source. No transformations will be performed.

Returns:

  • (::Boolean) —

    Optional. If true, the job will run in dry run mode, returning the total object count and, if the object configuration is a prefix list, the bytes found from source. No transformations will be performed.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#error_summaries ⇒ ::Array<::Google::Cloud::StorageBatchOperations::V1::ErrorSummary> (readonly)

Returns Output only. Summarizes errors encountered with sample error log entries.

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#logging_config ⇒ ::Google::Cloud::StorageBatchOperations::V1::LoggingConfig

Returns Optional. Logging configuration.

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#name ⇒ ::String

Returns Identifier. The resource name of the Job. job_id is unique within the project, that is either set by the customer or defined by the service. Format: projects/{project}/locations/global/jobs/{job_id} . For example: "projects/123456/locations/global/jobs/job01".

Returns:

  • (::String) —

    Identifier. The resource name of the Job. job_id is unique within the project, that is either set by the customer or defined by the service. Format: projects/{project}/locations/global/jobs/{job_id} . For example: "projects/123456/locations/global/jobs/job01".



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#put_metadata ⇒ ::Google::Cloud::StorageBatchOperations::V1::PutMetadata

Returns Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time.

Note: The following fields are mutually exclusive: put_metadata, put_object_hold, delete_object, rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::StorageBatchOperations::V1::PutMetadata) —

    Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time.

    Note: The following fields are mutually exclusive: put_metadata, put_object_hold, delete_object, rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#put_object_hold ⇒ ::Google::Cloud::StorageBatchOperations::V1::PutObjectHold

Returns Changes object hold status.

Note: The following fields are mutually exclusive: put_object_hold, delete_object, put_metadata, rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::StorageBatchOperations::V1::PutObjectHold) —

    Changes object hold status.

    Note: The following fields are mutually exclusive: put_object_hold, delete_object, put_metadata, rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#rewrite_object ⇒ ::Google::Cloud::StorageBatchOperations::V1::RewriteObject

Returns Rewrite the object and updates metadata like KMS key.

Note: The following fields are mutually exclusive: rewrite_object, put_object_hold, delete_object, put_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::StorageBatchOperations::V1::RewriteObject) —

    Rewrite the object and updates metadata like KMS key.

    Note: The following fields are mutually exclusive: rewrite_object, put_object_hold, delete_object, put_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#schedule_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time that the job was scheduled.

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end

#state ⇒ ::Google::Cloud::StorageBatchOperations::V1::Job::State (readonly)

Returns Output only. State of the job.

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 87

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes state of a job.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # In progress.
    RUNNING = 1

    # Completed successfully.
    SUCCEEDED = 2

    # Cancelled by the user.
    CANCELED = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4
  end
end