Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Request for creating an empty table. **Deprecated**: Use `DeclareTableRequest`
|**context** | **Map<String, String>** | Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation. REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention `x-lance-ctx-<key>: <value>`. For example, a context entry `{\"trace_id\": \"abc123\"}` would be sent as the header `x-lance-ctx-trace_id: abc123`. | [optional] |
|**id** | **List<String>** | | [optional] |
|**location** | **String** | Optional storage location for the table. If not provided, the namespace implementation should determine the table location. | [optional] |
|**vendCredentials** | **Boolean** | Whether to include vended credentials in the response `storage_options`. When true, the implementation should provide vended credentials for accessing storage. When not set, the implementation can decide whether to return vended credentials. | [optional] |



1 change: 1 addition & 0 deletions docs/src/client/operations/models/DeclareTableRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Request for declaring a table.
|**context** | **Map<String, String>** | Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation. REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention `x-lance-ctx-<key>: <value>`. For example, a context entry `{\"trace_id\": \"abc123\"}` would be sent as the header `x-lance-ctx-trace_id: abc123`. | [optional] |
|**id** | **List<String>** | | [optional] |
|**location** | **String** | Optional storage location for the table. If not provided, the namespace implementation should determine the table location. | [optional] |
|**vendCredentials** | **Boolean** | Whether to include vended credentials in the response `storage_options`. When true, the implementation should provide vended credentials for accessing storage. When not set, the implementation can decide whether to return vended credentials. | [optional] |



12 changes: 12 additions & 0 deletions docs/src/rest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2946,6 +2946,12 @@ components:
description: |
Optional storage location for the table.
If not provided, the namespace implementation should determine the table location.
vend_credentials:
description: |
Whether to include vended credentials in the response `storage_options`.
When true, the implementation should provide vended credentials for accessing storage.
When not set, the implementation can decide whether to return vended credentials.
type: boolean

CreateEmptyTableResponse:
type: object
Expand Down Expand Up @@ -2987,6 +2993,12 @@ components:
description: |
Optional storage location for the table.
If not provided, the namespace implementation should determine the table location.
vend_credentials:
description: |
Whether to include vended credentials in the response `storage_options`.
When true, the implementation should provide vended credentials for accessing storage.
When not set, the implementation can decide whether to return vended credentials.
type: boolean

DeclareTableResponse:
type: object
Expand Down
14 changes: 14 additions & 0 deletions java/lance-namespace-apache-client/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4120,6 +4120,7 @@ components:
id:
- id
- id
vend_credentials: true
properties:
identity:
$ref: '#/components/schemas/Identity'
Expand All @@ -4143,6 +4144,12 @@ components:
Optional storage location for the table.
If not provided, the namespace implementation should determine the table location.
type: string
vend_credentials:
description: |
Whether to include vended credentials in the response `storage_options`.
When true, the implementation should provide vended credentials for accessing storage.
When not set, the implementation can decide whether to return vended credentials.
type: boolean
CreateEmptyTableResponse:
deprecated: true
description: |
Expand Down Expand Up @@ -4180,6 +4187,7 @@ components:
id:
- id
- id
vend_credentials: true
properties:
identity:
$ref: '#/components/schemas/Identity'
Expand All @@ -4203,6 +4211,12 @@ components:
Optional storage location for the table.
If not provided, the namespace implementation should determine the table location.
type: string
vend_credentials:
description: |
Whether to include vended credentials in the response `storage_options`.
When true, the implementation should provide vended credentials for accessing storage.
When not set, the implementation can decide whether to return vended credentials.
type: boolean
DeclareTableResponse:
description: |
Response for declaring a table.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Request for creating an empty table. **Deprecated**: Use `DeclareTableRequest`
|**context** | **Map<String, String>** | Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation. REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention `x-lance-ctx-<key>: <value>`. For example, a context entry `{\"trace_id\": \"abc123\"}` would be sent as the header `x-lance-ctx-trace_id: abc123`. | [optional] |
|**id** | **List<String>** | | [optional] |
|**location** | **String** | Optional storage location for the table. If not provided, the namespace implementation should determine the table location. | [optional] |
|**vendCredentials** | **Boolean** | Whether to include vended credentials in the response `storage_options`. When true, the implementation should provide vended credentials for accessing storage. When not set, the implementation can decide whether to return vended credentials. | [optional] |



Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Request for declaring a table.
|**context** | **Map<String, String>** | Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation. REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention `x-lance-ctx-<key>: <value>`. For example, a context entry `{\"trace_id\": \"abc123\"}` would be sent as the header `x-lance-ctx-trace_id: abc123`. | [optional] |
|**id** | **List<String>** | | [optional] |
|**location** | **String** | Optional storage location for the table. If not provided, the namespace implementation should determine the table location. | [optional] |
|**vendCredentials** | **Boolean** | Whether to include vended credentials in the response `storage_options`. When true, the implementation should provide vended credentials for accessing storage. When not set, the implementation can decide whether to return vended credentials. | [optional] |



Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@
CreateEmptyTableRequest.JSON_PROPERTY_IDENTITY,
CreateEmptyTableRequest.JSON_PROPERTY_CONTEXT,
CreateEmptyTableRequest.JSON_PROPERTY_ID,
CreateEmptyTableRequest.JSON_PROPERTY_LOCATION
CreateEmptyTableRequest.JSON_PROPERTY_LOCATION,
CreateEmptyTableRequest.JSON_PROPERTY_VEND_CREDENTIALS
})
@javax.annotation.Generated(
value = "org.openapitools.codegen.languages.JavaClientCodegen",
Expand All @@ -54,6 +55,9 @@ public class CreateEmptyTableRequest {
public static final String JSON_PROPERTY_LOCATION = "location";
@javax.annotation.Nullable private String location;

public static final String JSON_PROPERTY_VEND_CREDENTIALS = "vend_credentials";
@javax.annotation.Nullable private Boolean vendCredentials;

public CreateEmptyTableRequest() {}

public CreateEmptyTableRequest identity(@javax.annotation.Nullable Identity identity) {
Expand Down Expand Up @@ -173,6 +177,33 @@ public void setLocation(@javax.annotation.Nullable String location) {
this.location = location;
}

public CreateEmptyTableRequest vendCredentials(
@javax.annotation.Nullable Boolean vendCredentials) {

this.vendCredentials = vendCredentials;
return this;
}

/**
* Whether to include vended credentials in the response `storage_options`. When true,
* the implementation should provide vended credentials for accessing storage. When not set, the
* implementation can decide whether to return vended credentials.
*
* @return vendCredentials
*/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_VEND_CREDENTIALS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Boolean getVendCredentials() {
return vendCredentials;
}

@JsonProperty(JSON_PROPERTY_VEND_CREDENTIALS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setVendCredentials(@javax.annotation.Nullable Boolean vendCredentials) {
this.vendCredentials = vendCredentials;
}

@Override
public boolean equals(Object o) {
if (this == o) {
Expand All @@ -185,12 +216,13 @@ public boolean equals(Object o) {
return Objects.equals(this.identity, createEmptyTableRequest.identity)
&& Objects.equals(this.context, createEmptyTableRequest.context)
&& Objects.equals(this.id, createEmptyTableRequest.id)
&& Objects.equals(this.location, createEmptyTableRequest.location);
&& Objects.equals(this.location, createEmptyTableRequest.location)
&& Objects.equals(this.vendCredentials, createEmptyTableRequest.vendCredentials);
}

@Override
public int hashCode() {
return Objects.hash(identity, context, id, location);
return Objects.hash(identity, context, id, location, vendCredentials);
}

@Override
Expand All @@ -201,6 +233,7 @@ public String toString() {
sb.append(" context: ").append(toIndentedString(context)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" location: ").append(toIndentedString(location)).append("\n");
sb.append(" vendCredentials: ").append(toIndentedString(vendCredentials)).append("\n");
sb.append("}");
return sb.toString();
}
Expand Down Expand Up @@ -311,6 +344,22 @@ public String toUrlQueryString(String prefix) {
}
}

// add `vend_credentials` to the URL query string
if (getVendCredentials() != null) {
try {
joiner.add(
String.format(
"%svend_credentials%s=%s",
prefix,
suffix,
URLEncoder.encode(String.valueOf(getVendCredentials()), "UTF-8")
.replaceAll("\\+", "%20")));
} catch (UnsupportedEncodingException e) {
// Should never happen, UTF-8 is always supported
throw new RuntimeException(e);
}
}

return joiner.toString();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@
DeclareTableRequest.JSON_PROPERTY_IDENTITY,
DeclareTableRequest.JSON_PROPERTY_CONTEXT,
DeclareTableRequest.JSON_PROPERTY_ID,
DeclareTableRequest.JSON_PROPERTY_LOCATION
DeclareTableRequest.JSON_PROPERTY_LOCATION,
DeclareTableRequest.JSON_PROPERTY_VEND_CREDENTIALS
})
@javax.annotation.Generated(
value = "org.openapitools.codegen.languages.JavaClientCodegen",
Expand All @@ -49,6 +50,9 @@ public class DeclareTableRequest {
public static final String JSON_PROPERTY_LOCATION = "location";
@javax.annotation.Nullable private String location;

public static final String JSON_PROPERTY_VEND_CREDENTIALS = "vend_credentials";
@javax.annotation.Nullable private Boolean vendCredentials;

public DeclareTableRequest() {}

public DeclareTableRequest identity(@javax.annotation.Nullable Identity identity) {
Expand Down Expand Up @@ -168,6 +172,32 @@ public void setLocation(@javax.annotation.Nullable String location) {
this.location = location;
}

public DeclareTableRequest vendCredentials(@javax.annotation.Nullable Boolean vendCredentials) {

this.vendCredentials = vendCredentials;
return this;
}

/**
* Whether to include vended credentials in the response `storage_options`. When true,
* the implementation should provide vended credentials for accessing storage. When not set, the
* implementation can decide whether to return vended credentials.
*
* @return vendCredentials
*/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_VEND_CREDENTIALS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Boolean getVendCredentials() {
return vendCredentials;
}

@JsonProperty(JSON_PROPERTY_VEND_CREDENTIALS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setVendCredentials(@javax.annotation.Nullable Boolean vendCredentials) {
this.vendCredentials = vendCredentials;
}

@Override
public boolean equals(Object o) {
if (this == o) {
Expand All @@ -180,12 +210,13 @@ public boolean equals(Object o) {
return Objects.equals(this.identity, declareTableRequest.identity)
&& Objects.equals(this.context, declareTableRequest.context)
&& Objects.equals(this.id, declareTableRequest.id)
&& Objects.equals(this.location, declareTableRequest.location);
&& Objects.equals(this.location, declareTableRequest.location)
&& Objects.equals(this.vendCredentials, declareTableRequest.vendCredentials);
}

@Override
public int hashCode() {
return Objects.hash(identity, context, id, location);
return Objects.hash(identity, context, id, location, vendCredentials);
}

@Override
Expand All @@ -196,6 +227,7 @@ public String toString() {
sb.append(" context: ").append(toIndentedString(context)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" location: ").append(toIndentedString(location)).append("\n");
sb.append(" vendCredentials: ").append(toIndentedString(vendCredentials)).append("\n");
sb.append("}");
return sb.toString();
}
Expand Down Expand Up @@ -306,6 +338,22 @@ public String toUrlQueryString(String prefix) {
}
}

// add `vend_credentials` to the URL query string
if (getVendCredentials() != null) {
try {
joiner.add(
String.format(
"%svend_credentials%s=%s",
prefix,
suffix,
URLEncoder.encode(String.valueOf(getVendCredentials()), "UTF-8")
.replaceAll("\\+", "%20")));
} catch (UnsupportedEncodingException e) {
// Should never happen, UTF-8 is always supported
throw new RuntimeException(e);
}
}

return joiner.toString();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ public class CreateEmptyTableRequest {

private String location;

private Boolean vendCredentials;

public CreateEmptyTableRequest identity(Identity identity) {
this.identity = identity;
return this;
Expand Down Expand Up @@ -158,6 +160,32 @@ public void setLocation(String location) {
this.location = location;
}

public CreateEmptyTableRequest vendCredentials(Boolean vendCredentials) {
this.vendCredentials = vendCredentials;
return this;
}

/**
* Whether to include vended credentials in the response `storage_options`. When true, the
* implementation should provide vended credentials for accessing storage. When not set, the
* implementation can decide whether to return vended credentials.
*
* @return vendCredentials
*/
@Schema(
name = "vend_credentials",
description =
"Whether to include vended credentials in the response `storage_options`. When true, the implementation should provide vended credentials for accessing storage. When not set, the implementation can decide whether to return vended credentials. ",
requiredMode = Schema.RequiredMode.NOT_REQUIRED)
@JsonProperty("vend_credentials")
public Boolean getVendCredentials() {
return vendCredentials;
}

public void setVendCredentials(Boolean vendCredentials) {
this.vendCredentials = vendCredentials;
}

@Override
public boolean equals(Object o) {
if (this == o) {
Expand All @@ -170,12 +198,13 @@ public boolean equals(Object o) {
return Objects.equals(this.identity, createEmptyTableRequest.identity)
&& Objects.equals(this.context, createEmptyTableRequest.context)
&& Objects.equals(this.id, createEmptyTableRequest.id)
&& Objects.equals(this.location, createEmptyTableRequest.location);
&& Objects.equals(this.location, createEmptyTableRequest.location)
&& Objects.equals(this.vendCredentials, createEmptyTableRequest.vendCredentials);
}

@Override
public int hashCode() {
return Objects.hash(identity, context, id, location);
return Objects.hash(identity, context, id, location, vendCredentials);
}

@Override
Expand All @@ -186,6 +215,7 @@ public String toString() {
sb.append(" context: ").append(toIndentedString(context)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" location: ").append(toIndentedString(location)).append("\n");
sb.append(" vendCredentials: ").append(toIndentedString(vendCredentials)).append("\n");
sb.append("}");
return sb.toString();
}
Expand Down
Loading
Loading