Class: Google::Cloud::Video::Transcoder::V1beta1::Job

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb

Overview

Transcoding job resource.

Defined Under Namespace

Modules: ProcessingState Classes: OriginUri

Instance Attribute Summary collapse

Instance Attribute Details

#config ⇒ ::Google::Cloud::Video::Transcoder::V1beta1::JobConfig

Returns The configuration for this job.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

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

Returns Output only. The time the job was created.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

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

Returns Output only. The time the transcoding finished.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

#failure_details ⇒ ::Array<::Google::Cloud::Video::Transcoder::V1beta1::FailureDetail> (readonly)

Returns Output only. List of failure details. This property may contain additional information about the failure when failure_reason is present.

.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

#failure_reason ⇒ ::String (readonly)

Returns Output only. A description of the reason for the failure. This property is always present when state is FAILED.

Returns:

  • (::String) —

    Output only. A description of the reason for the failure. This property is always present when state is FAILED.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

#input_uri ⇒ ::String

Returns Input only. Specify the input_uri to populate empty uri fields in each element of Job.config.inputs or JobTemplate.config.inputs when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, gs://bucket/inputs/file.mp4).

Returns:

  • (::String) —

    Input only. Specify the input_uri to populate empty uri fields in each element of Job.config.inputs or JobTemplate.config.inputs when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, gs://bucket/inputs/file.mp4).



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

#name ⇒ ::String

Returns The resource name of the job. Format: projects/{project}/locations/{location}/jobs/{job}.

Returns:

  • (::String) —

    The resource name of the job. Format: projects/{project}/locations/{location}/jobs/{job}



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

#origin_uri ⇒ ::Google::Cloud::Video::Transcoder::V1beta1::Job::OriginUri (readonly)

Returns Output only. The origin URI.

.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

#output_uri ⇒ ::String

Returns Input only. Specify the output_uri to populate an empty Job.config.output.uri or JobTemplate.config.output.uri when using template. URI for the output file(s). For example, gs://my-bucket/outputs/.

Returns:

  • (::String) —

    Input only. Specify the output_uri to populate an empty Job.config.output.uri or JobTemplate.config.output.uri when using template. URI for the output file(s). For example, gs://my-bucket/outputs/.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

#priority ⇒ ::Integer

Returns Specify the priority of the job. Enter a value between 0 and 100, where 0 is the lowest priority and 100 is the highest priority. The default is 0.

Returns:

  • (::Integer) —

    Specify the priority of the job. Enter a value between 0 and 100, where 0 is the lowest priority and 100 is the highest priority. The default is 0.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

#progress ⇒ ::Google::Cloud::Video::Transcoder::V1beta1::Progress (readonly)

Returns Output only. Estimated fractional progress, from 0 to 1 for each step.

.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

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

Returns Output only. The time the transcoding started.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

#state ⇒ ::Google::Cloud::Video::Transcoder::V1beta1::Job::ProcessingState (readonly)

Returns Output only. The current state of the job.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

#template_id ⇒ ::String

Returns Input only. Specify the template_id to use for populating Job.config. The default is preset/web-hd.

Preset Transcoder templates:

  • preset/{preset_id}

  • User defined JobTemplate: {job_template_id}.

Returns:

  • (::String) —

    Input only. Specify the template_id to use for populating Job.config. The default is preset/web-hd.

    Preset Transcoder templates:

    • preset/{preset_id}

    • User defined JobTemplate: {job_template_id}



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end

#ttl_after_completion_days ⇒ ::Integer

Returns Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.

Returns:

  • (::Integer) —

    Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 93

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

  # The origin URI.
  # @!attribute [rw] hls
  #   @return [::String]
  #     HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4.
  #     If multiple HLS manifests are created, only the first one is listed.
  # @!attribute [rw] dash
  #   @return [::String]
  #     Dash manifest URI. If multiple Dash manifests are created, only the first
  #     one is listed.
  class OriginUri
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the job.
  module ProcessingState
    # The processing state is not specified.
    PROCESSING_STATE_UNSPECIFIED = 0

    # The job is enqueued and will be picked up for processing soon.
    PENDING = 1

    # The job is being processed.
    RUNNING = 2

    # The job has been completed successfully.
    SUCCEEDED = 3

    # The job has failed. For additional information, see `failure_reason` and
    # `failure_details`
    FAILED = 4
  end
end