Class ApiservingMediaResponseInfo

This message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 }

Inheritance
object
ApiservingMediaResponseInfo
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class ApiservingMediaResponseInfo : IDirectResponseSchema

Properties

CustomData

Data to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.

Declaration
[JsonProperty("customData")]
public virtual string CustomData { get; set; }
Property Value
Type Description
string

DataStorageTransform

Specifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform.

Declaration
[JsonProperty("dataStorageTransform")]
public virtual string DataStorageTransform { get; set; }
Property Value
Type Description
string

DestinationBlobMintIndex

For the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when writing the resulting blob. This field is optional. It's not required ever, even if original_object_blob_mint_index is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.

Declaration
[JsonProperty("destinationBlobMintIndex")]
public virtual int? DestinationBlobMintIndex { get; set; }
Property Value
Type Description
int?

DynamicDropTarget

Specifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget.

Declaration
[JsonProperty("dynamicDropTarget")]
public virtual string DynamicDropTarget { get; set; }
Property Value
Type Description
string

DynamicDropzone

Specifies the Scotty dropzone to use for uploads.

Declaration
[JsonProperty("dynamicDropzone")]
public virtual string DynamicDropzone { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

MediaForDiff

Diff Updates must respond to a START notification with this Media proto to tell Scotty to decode the diff encoded payload and apply the diff against this field. If the request was diff encoded, but this field is not set, Scotty will treat the encoding as identity. This is corresponding to Apiary's DiffUploadResponse.original_object (//depot/google3/gdata/rosy/proto/data.proto?l=413). See go/esf-scotty-diff-upload for more information.

Declaration
[JsonProperty("mediaForDiff")]
public virtual GdataMedia MediaForDiff { get; set; }
Property Value
Type Description
GdataMedia

OriginalObjectBlobMintIndex

For the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when reading the original blob. This field is optional. It's not required ever, even if destination_blob_mint_index is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.

Declaration
[JsonProperty("originalObjectBlobMintIndex")]
public virtual int? OriginalObjectBlobMintIndex { get; set; }
Property Value
Type Description
int?

RequestClass

Request class to use for all Blobstore operations for this request.

Declaration
[JsonProperty("requestClass")]
public virtual string RequestClass { get; set; }
Property Value
Type Description
string

ScottyAgentUserId

Requester ID passed along to be recorded in the Scotty logs

Declaration
[JsonProperty("scottyAgentUserId")]
public virtual long? ScottyAgentUserId { get; set; }
Property Value
Type Description
long?

ScottyCustomerLog

Customer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog

Declaration
[JsonProperty("scottyCustomerLog")]
public virtual string ScottyCustomerLog { get; set; }
Property Value
Type Description
string

TrafficClassField

Specifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.

Declaration
[JsonProperty("trafficClassField")]
public virtual string TrafficClassField { get; set; }
Property Value
Type Description
string

VerifyHashFromHeader

Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header.

Declaration
[JsonProperty("verifyHashFromHeader")]
public virtual bool? VerifyHashFromHeader { get; set; }
Property Value
Type Description
bool?

Implements