diff --git a/api/swagger.yml b/api/swagger.yml index 807f3a5992f..076005f3693 100644 --- a/api/swagger.yml +++ b/api/swagger.yml @@ -320,6 +320,10 @@ components: size_bytes: type: integer format: int64 + description: | + The number of bytes in the object. lakeFS always populates this + field when returning ObjectStats. This field is optional _for + the client_ to supply, for instance on upload. mtime: type: integer format: int64 diff --git a/clients/java-legacy/api/openapi.yaml b/clients/java-legacy/api/openapi.yaml index b0bbff61d58..a6ac7e8b841 100644 --- a/clients/java-legacy/api/openapi.yaml +++ b/clients/java-legacy/api/openapi.yaml @@ -7282,6 +7282,10 @@ components: checksum: type: string size_bytes: + description: | + The number of bytes in the object. lakeFS always populates this + field when returning ObjectStats. This field is optional _for + the client_ to supply, for instance on upload. format: int64 type: integer mtime: diff --git a/clients/java-legacy/docs/ObjectStats.md b/clients/java-legacy/docs/ObjectStats.md index ed818768da7..011ee0c4ba3 100644 --- a/clients/java-legacy/docs/ObjectStats.md +++ b/clients/java-legacy/docs/ObjectStats.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **physicalAddress** | **String** | The location of the object on the underlying object store. Formatted as a native URI with the object store type as scheme (\"s3://...\", \"gs://...\", etc.) Or, in the case of presign=true, will be an HTTP URL to be consumed via regular HTTP GET | **physicalAddressExpiry** | **Long** | If present and nonzero, physical_address is a pre-signed URL and will expire at this Unix Epoch time. This will be shorter than the pre-signed URL lifetime if an authentication token is about to expire. This field is *optional*. | [optional] **checksum** | **String** | | -**sizeBytes** | **Long** | | [optional] +**sizeBytes** | **Long** | The number of bytes in the object. lakeFS always populates this field when returning ObjectStats. This field is optional _for the client_ to supply, for instance on upload. | [optional] **mtime** | **Long** | Unix Epoch in seconds | **metadata** | **Map<String, String>** | | [optional] **contentType** | **String** | Object media type | [optional] diff --git a/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/ObjectStats.java b/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/ObjectStats.java index dc80b641be8..781ee4a36ce 100644 --- a/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/ObjectStats.java +++ b/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/ObjectStats.java @@ -238,11 +238,11 @@ public ObjectStats sizeBytes(Long sizeBytes) { } /** - * Get sizeBytes + * The number of bytes in the object. lakeFS always populates this field when returning ObjectStats. This field is optional _for the client_ to supply, for instance on upload. * @return sizeBytes **/ @javax.annotation.Nullable - @ApiModelProperty(value = "") + @ApiModelProperty(value = "The number of bytes in the object. lakeFS always populates this field when returning ObjectStats. This field is optional _for the client_ to supply, for instance on upload. ") public Long getSizeBytes() { return sizeBytes; diff --git a/clients/java/api/openapi.yaml b/clients/java/api/openapi.yaml index d7f18c7913d..f991b4f0e81 100644 --- a/clients/java/api/openapi.yaml +++ b/clients/java/api/openapi.yaml @@ -7256,6 +7256,10 @@ components: checksum: type: string size_bytes: + description: | + The number of bytes in the object. lakeFS always populates this + field when returning ObjectStats. This field is optional _for + the client_ to supply, for instance on upload. format: int64 type: integer mtime: diff --git a/clients/java/docs/ObjectStats.md b/clients/java/docs/ObjectStats.md index 94e2c738e6e..a528e9e717a 100644 --- a/clients/java/docs/ObjectStats.md +++ b/clients/java/docs/ObjectStats.md @@ -12,7 +12,7 @@ |**physicalAddress** | **String** | The location of the object on the underlying object store. Formatted as a native URI with the object store type as scheme (\"s3://...\", \"gs://...\", etc.) Or, in the case of presign=true, will be an HTTP URL to be consumed via regular HTTP GET | | |**physicalAddressExpiry** | **Long** | If present and nonzero, physical_address is a pre-signed URL and will expire at this Unix Epoch time. This will be shorter than the pre-signed URL lifetime if an authentication token is about to expire. This field is *optional*. | [optional] | |**checksum** | **String** | | | -|**sizeBytes** | **Long** | | [optional] | +|**sizeBytes** | **Long** | The number of bytes in the object. lakeFS always populates this field when returning ObjectStats. This field is optional _for the client_ to supply, for instance on upload. | [optional] | |**mtime** | **Long** | Unix Epoch in seconds | | |**metadata** | **Map<String, String>** | | [optional] | |**contentType** | **String** | Object media type | [optional] | diff --git a/clients/java/src/main/java/io/lakefs/clients/sdk/model/ObjectStats.java b/clients/java/src/main/java/io/lakefs/clients/sdk/model/ObjectStats.java index bc6889d2aaa..f211b1aa9c8 100644 --- a/clients/java/src/main/java/io/lakefs/clients/sdk/model/ObjectStats.java +++ b/clients/java/src/main/java/io/lakefs/clients/sdk/model/ObjectStats.java @@ -252,7 +252,7 @@ public ObjectStats sizeBytes(Long sizeBytes) { } /** - * Get sizeBytes + * The number of bytes in the object. lakeFS always populates this field when returning ObjectStats. This field is optional _for the client_ to supply, for instance on upload. * @return sizeBytes **/ @javax.annotation.Nullable diff --git a/clients/python-legacy/docs/ObjectStats.md b/clients/python-legacy/docs/ObjectStats.md index d5be770ca89..4568b937c7a 100644 --- a/clients/python-legacy/docs/ObjectStats.md +++ b/clients/python-legacy/docs/ObjectStats.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **checksum** | **str** | | **mtime** | **int** | Unix Epoch in seconds | **physical_address_expiry** | **int** | If present and nonzero, physical_address is a pre-signed URL and will expire at this Unix Epoch time. This will be shorter than the pre-signed URL lifetime if an authentication token is about to expire. This field is *optional*. | [optional] -**size_bytes** | **int** | | [optional] +**size_bytes** | **int** | The number of bytes in the object. lakeFS always populates this field when returning ObjectStats. This field is optional _for the client_ to supply, for instance on upload. | [optional] **metadata** | [**ObjectUserMetadata**](ObjectUserMetadata.md) | | [optional] **content_type** | **str** | Object media type | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/clients/python-legacy/lakefs_client/model/object_stats.py b/clients/python-legacy/lakefs_client/model/object_stats.py index e49f4ac498a..9864b4f6ed7 100644 --- a/clients/python-legacy/lakefs_client/model/object_stats.py +++ b/clients/python-legacy/lakefs_client/model/object_stats.py @@ -169,7 +169,7 @@ def _from_openapi_data(cls, path, path_type, physical_address, checksum, mtime, through its discriminator because we passed in _visited_composed_classes = (Animal,) physical_address_expiry (int): If present and nonzero, physical_address is a pre-signed URL and will expire at this Unix Epoch time. This will be shorter than the pre-signed URL lifetime if an authentication token is about to expire. This field is *optional*. . [optional] # noqa: E501 - size_bytes (int): [optional] # noqa: E501 + size_bytes (int): The number of bytes in the object. lakeFS always populates this field when returning ObjectStats. This field is optional _for the client_ to supply, for instance on upload. . [optional] # noqa: E501 metadata (ObjectUserMetadata): [optional] # noqa: E501 content_type (str): Object media type. [optional] # noqa: E501 """ @@ -266,7 +266,7 @@ def __init__(self, path, path_type, physical_address, checksum, mtime, *args, ** through its discriminator because we passed in _visited_composed_classes = (Animal,) physical_address_expiry (int): If present and nonzero, physical_address is a pre-signed URL and will expire at this Unix Epoch time. This will be shorter than the pre-signed URL lifetime if an authentication token is about to expire. This field is *optional*. . [optional] # noqa: E501 - size_bytes (int): [optional] # noqa: E501 + size_bytes (int): The number of bytes in the object. lakeFS always populates this field when returning ObjectStats. This field is optional _for the client_ to supply, for instance on upload. . [optional] # noqa: E501 metadata (ObjectUserMetadata): [optional] # noqa: E501 content_type (str): Object media type. [optional] # noqa: E501 """ diff --git a/clients/python/docs/ObjectStats.md b/clients/python/docs/ObjectStats.md index fd2a7bfd003..2f94708e3af 100644 --- a/clients/python/docs/ObjectStats.md +++ b/clients/python/docs/ObjectStats.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **physical_address** | **str** | The location of the object on the underlying object store. Formatted as a native URI with the object store type as scheme (\"s3://...\", \"gs://...\", etc.) Or, in the case of presign=true, will be an HTTP URL to be consumed via regular HTTP GET | **physical_address_expiry** | **int** | If present and nonzero, physical_address is a pre-signed URL and will expire at this Unix Epoch time. This will be shorter than the pre-signed URL lifetime if an authentication token is about to expire. This field is *optional*. | [optional] **checksum** | **str** | | -**size_bytes** | **int** | | [optional] +**size_bytes** | **int** | The number of bytes in the object. lakeFS always populates this field when returning ObjectStats. This field is optional _for the client_ to supply, for instance on upload. | [optional] **mtime** | **int** | Unix Epoch in seconds | **metadata** | **Dict[str, str]** | | [optional] **content_type** | **str** | Object media type | [optional] diff --git a/clients/python/lakefs_sdk/models/object_stats.py b/clients/python/lakefs_sdk/models/object_stats.py index 4ea3204bdbe..434342171f5 100644 --- a/clients/python/lakefs_sdk/models/object_stats.py +++ b/clients/python/lakefs_sdk/models/object_stats.py @@ -34,7 +34,7 @@ class ObjectStats(BaseModel): physical_address: StrictStr = Field(..., description="The location of the object on the underlying object store. Formatted as a native URI with the object store type as scheme (\"s3://...\", \"gs://...\", etc.) Or, in the case of presign=true, will be an HTTP URL to be consumed via regular HTTP GET ") physical_address_expiry: Optional[StrictInt] = Field(None, description="If present and nonzero, physical_address is a pre-signed URL and will expire at this Unix Epoch time. This will be shorter than the pre-signed URL lifetime if an authentication token is about to expire. This field is *optional*. ") checksum: StrictStr = Field(...) - size_bytes: Optional[StrictInt] = None + size_bytes: Optional[StrictInt] = Field(None, description="The number of bytes in the object. lakeFS always populates this field when returning ObjectStats. This field is optional _for the client_ to supply, for instance on upload. ") mtime: StrictInt = Field(..., description="Unix Epoch in seconds") metadata: Optional[Dict[str, StrictStr]] = None content_type: Optional[StrictStr] = Field(None, description="Object media type") diff --git a/clients/rust/docs/ObjectStats.md b/clients/rust/docs/ObjectStats.md index b09ed0d4472..d4166018f11 100644 --- a/clients/rust/docs/ObjectStats.md +++ b/clients/rust/docs/ObjectStats.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **physical_address** | **String** | The location of the object on the underlying object store. Formatted as a native URI with the object store type as scheme (\"s3://...\", \"gs://...\", etc.) Or, in the case of presign=true, will be an HTTP URL to be consumed via regular HTTP GET | **physical_address_expiry** | Option<**i64**> | If present and nonzero, physical_address is a pre-signed URL and will expire at this Unix Epoch time. This will be shorter than the pre-signed URL lifetime if an authentication token is about to expire. This field is *optional*. | [optional] **checksum** | **String** | | -**size_bytes** | Option<**i64**> | | [optional] +**size_bytes** | Option<**i64**> | The number of bytes in the object. lakeFS always populates this field when returning ObjectStats. This field is optional _for the client_ to supply, for instance on upload. | [optional] **mtime** | **i64** | Unix Epoch in seconds | **metadata** | Option<**std::collections::HashMap**> | | [optional] **content_type** | Option<**String**> | Object media type | [optional] diff --git a/clients/rust/src/models/object_stats.rs b/clients/rust/src/models/object_stats.rs index 8798f2df20c..377cdf57aa9 100644 --- a/clients/rust/src/models/object_stats.rs +++ b/clients/rust/src/models/object_stats.rs @@ -24,6 +24,7 @@ pub struct ObjectStats { pub physical_address_expiry: Option, #[serde(rename = "checksum")] pub checksum: String, + /// The number of bytes in the object. lakeFS always populates this field when returning ObjectStats. This field is optional _for the client_ to supply, for instance on upload. #[serde(rename = "size_bytes", skip_serializing_if = "Option::is_none")] pub size_bytes: Option, /// Unix Epoch in seconds diff --git a/docs/assets/js/swagger.yml b/docs/assets/js/swagger.yml index 807f3a5992f..076005f3693 100644 --- a/docs/assets/js/swagger.yml +++ b/docs/assets/js/swagger.yml @@ -320,6 +320,10 @@ components: size_bytes: type: integer format: int64 + description: | + The number of bytes in the object. lakeFS always populates this + field when returning ObjectStats. This field is optional _for + the client_ to supply, for instance on upload. mtime: type: integer format: int64