#5862

Committed 16 Dec 2025 03:46PM UTC coverage: 12.903% (-0.4%) from 13.29%

Build # #5862

Build Type

push

github

Committed by

web-flow

Commit Message

feat(boxsdkgen): treat `nullable` fields as Optional (box/box-codegen#906) (#1633)

Run Details

0 of 224 new or added lines in 8 files covered. (0.0%)

639 existing lines in 7 files now uncovered.

8374 of 64898 relevant lines covered (12.9%)

0.13 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/main/java/com/box/sdkgen/managers/filemetadata/FileMetadataManager.java

package com.box.sdkgen.managers.filemetadata;

import static com.box.sdkgen.internal.utils.UtilsManager.convertToString;
import static com.box.sdkgen.internal.utils.UtilsManager.entryOf;
import static com.box.sdkgen.internal.utils.UtilsManager.mapOf;
import static com.box.sdkgen.internal.utils.UtilsManager.mergeMaps;
import static com.box.sdkgen.internal.utils.UtilsManager.prepareParams;

import com.box.sdkgen.networking.auth.Authentication;
import com.box.sdkgen.networking.fetchoptions.FetchOptions;
import com.box.sdkgen.networking.fetchoptions.ResponseFormat;
import com.box.sdkgen.networking.fetchresponse.FetchResponse;
import com.box.sdkgen.networking.network.NetworkSession;
import com.box.sdkgen.schemas.metadatafull.MetadataFull;
import com.box.sdkgen.schemas.metadatas.Metadatas;
import com.box.sdkgen.serialization.json.JsonManager;
import java.util.List;
import java.util.Map;

public class FileMetadataManager {

  public Authentication auth;

  public NetworkSession networkSession;

  public FileMetadataManager() {
    this.networkSession = new NetworkSession();
  }

  protected FileMetadataManager(Builder builder) {
    this.auth = builder.auth;
    this.networkSession = builder.networkSession;
  }

  /**
   * Retrieves all metadata for a given file.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   */
  public Metadatas getFileMetadata(String fileId) {
    return getFileMetadata(fileId, new GetFileMetadataQueryParams(), new GetFileMetadataHeaders());
  }

  /**
   * Retrieves all metadata for a given file.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   * @param queryParams Query parameters of getFileMetadata method
   */
  public Metadatas getFileMetadata(String fileId, GetFileMetadataQueryParams queryParams) {
    return getFileMetadata(fileId, queryParams, new GetFileMetadataHeaders());
  }

  /**
   * Retrieves all metadata for a given file.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   * @param headers Headers of getFileMetadata method
   */
  public Metadatas getFileMetadata(String fileId, GetFileMetadataHeaders headers) {
    return getFileMetadata(fileId, new GetFileMetadataQueryParams(), headers);
  }

  /**
   * Retrieves all metadata for a given file.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   * @param queryParams Query parameters of getFileMetadata method
   * @param headers Headers of getFileMetadata method
   */
  public Metadatas getFileMetadata(
      String fileId, GetFileMetadataQueryParams queryParams, GetFileMetadataHeaders headers) {
    Map<String, String> queryParamsMap =
        prepareParams(mapOf(entryOf("view", convertToString(queryParams.getView()))));
    Map<String, String> headersMap = prepareParams(mergeMaps(mapOf(), headers.getExtraHeaders()));
    FetchResponse response =
        this.networkSession
            .getNetworkClient()
            .fetch(
                new FetchOptions.Builder(
                        String.join(
                            "",
                            this.networkSession.getBaseUrls().getBaseUrl(),
                            "/2.0/files/",
                            convertToString(fileId),
                            "/metadata"),
                        "GET")
                    .params(queryParamsMap)
                    .headers(headersMap)
                    .responseFormat(ResponseFormat.JSON)
                    .auth(this.auth)
                    .networkSession(this.networkSession)
                    .build());
    return JsonManager.deserialize(response.getData(), Metadatas.class);
  }

  /**
   * Retrieves the instance of a metadata template that has been applied to a file.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   * @param scope The scope of the metadata template. Example: "global"
   * @param templateKey The name of the metadata template. Example: "properties"
   */
  public MetadataFull getFileMetadataById(
      String fileId, GetFileMetadataByIdScope scope, String templateKey) {
    return getFileMetadataById(
        fileId,
        scope,
        templateKey,
        new GetFileMetadataByIdQueryParams(),
        new GetFileMetadataByIdHeaders());
  }

  /**
   * Retrieves the instance of a metadata template that has been applied to a file.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   * @param scope The scope of the metadata template. Example: "global"
   * @param templateKey The name of the metadata template. Example: "properties"
   * @param queryParams Query parameters of getFileMetadataById method
   */
  public MetadataFull getFileMetadataById(
      String fileId,
      GetFileMetadataByIdScope scope,
      String templateKey,
      GetFileMetadataByIdQueryParams queryParams) {
    return getFileMetadataById(
        fileId, scope, templateKey, queryParams, new GetFileMetadataByIdHeaders());
  }

  /**
   * Retrieves the instance of a metadata template that has been applied to a file.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   * @param scope The scope of the metadata template. Example: "global"
   * @param templateKey The name of the metadata template. Example: "properties"
   * @param headers Headers of getFileMetadataById method
   */
  public MetadataFull getFileMetadataById(
      String fileId,
      GetFileMetadataByIdScope scope,
      String templateKey,
      GetFileMetadataByIdHeaders headers) {
    return getFileMetadataById(
        fileId, scope, templateKey, new GetFileMetadataByIdQueryParams(), headers);
  }

  /**
   * Retrieves the instance of a metadata template that has been applied to a file.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   * @param scope The scope of the metadata template. Example: "global"
   * @param templateKey The name of the metadata template. Example: "properties"
   * @param queryParams Query parameters of getFileMetadataById method
   * @param headers Headers of getFileMetadataById method
   */
  public MetadataFull getFileMetadataById(
      String fileId,
      GetFileMetadataByIdScope scope,
      String templateKey,
      GetFileMetadataByIdQueryParams queryParams,
      GetFileMetadataByIdHeaders headers) {
    Map<String, String> queryParamsMap =
        prepareParams(mapOf(entryOf("view", convertToString(queryParams.getView()))));
    Map<String, String> headersMap = prepareParams(mergeMaps(mapOf(), headers.getExtraHeaders()));
    FetchResponse response =
        this.networkSession
            .getNetworkClient()
            .fetch(
                new FetchOptions.Builder(
                        String.join(
                            "",
                            this.networkSession.getBaseUrls().getBaseUrl(),
                            "/2.0/files/",
                            convertToString(fileId),
                            "/metadata/",
                            convertToString(scope),
                            "/",
                            convertToString(templateKey)),
                        "GET")
                    .params(queryParamsMap)
                    .headers(headersMap)
                    .responseFormat(ResponseFormat.JSON)
                    .auth(this.auth)
                    .networkSession(this.networkSession)
                    .build());
    return JsonManager.deserialize(response.getData(), MetadataFull.class);
  }

  /**
   * Applies an instance of a metadata template to a file.
   *
   * <p>In most cases only values that are present in the metadata template will be accepted, except
   * for the `global.properties` template which accepts any key-value pair.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   * @param scope The scope of the metadata template. Example: "global"
   * @param templateKey The name of the metadata template. Example: "properties"
   * @param requestBody Request body of createFileMetadataById method
   */
  public MetadataFull createFileMetadataById(
      String fileId,
      CreateFileMetadataByIdScope scope,
      String templateKey,
      Map<String, Object> requestBody) {
    return createFileMetadataById(
        fileId, scope, templateKey, requestBody, new CreateFileMetadataByIdHeaders());
  }

  /**
   * Applies an instance of a metadata template to a file.
   *
   * <p>In most cases only values that are present in the metadata template will be accepted, except
   * for the `global.properties` template which accepts any key-value pair.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   * @param scope The scope of the metadata template. Example: "global"
   * @param templateKey The name of the metadata template. Example: "properties"
   * @param requestBody Request body of createFileMetadataById method
   * @param headers Headers of createFileMetadataById method
   */
  public MetadataFull createFileMetadataById(
      String fileId,
      CreateFileMetadataByIdScope scope,
      String templateKey,
      Map<String, Object> requestBody,
      CreateFileMetadataByIdHeaders headers) {
    Map<String, String> headersMap = prepareParams(mergeMaps(mapOf(), headers.getExtraHeaders()));
    FetchResponse response =
        this.networkSession
            .getNetworkClient()
            .fetch(
                new FetchOptions.Builder(
                        String.join(
                            "",
                            this.networkSession.getBaseUrls().getBaseUrl(),
                            "/2.0/files/",
                            convertToString(fileId),
                            "/metadata/",
                            convertToString(scope),
                            "/",
                            convertToString(templateKey)),
                        "POST")
                    .headers(headersMap)
                    .data(JsonManager.serialize(requestBody))
                    .contentType("application/json")
                    .responseFormat(ResponseFormat.JSON)
                    .auth(this.auth)
                    .networkSession(this.networkSession)
                    .build());
    return JsonManager.deserialize(response.getData(), MetadataFull.class);
  }

  /**
   * Updates a piece of metadata on a file.
   *
   * <p>The metadata instance can only be updated if the template has already been applied to the
   * file before. When editing metadata, only values that match the metadata template schema will be
   * accepted.
   *
   * <p>The update is applied atomically. If any errors occur during the application of the
   * operations, the metadata instance will not be changed.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   * @param scope The scope of the metadata template. Example: "global"
   * @param templateKey The name of the metadata template. Example: "properties"
   * @param requestBody Request body of updateFileMetadataById method
   */
  public MetadataFull updateFileMetadataById(
      String fileId,
      UpdateFileMetadataByIdScope scope,
      String templateKey,
      List<UpdateFileMetadataByIdRequestBody> requestBody) {
    return updateFileMetadataById(
        fileId, scope, templateKey, requestBody, new UpdateFileMetadataByIdHeaders());
  }

  /**
   * Updates a piece of metadata on a file.
   *
   * <p>The metadata instance can only be updated if the template has already been applied to the
   * file before. When editing metadata, only values that match the metadata template schema will be
   * accepted.
   *
   * <p>The update is applied atomically. If any errors occur during the application of the
   * operations, the metadata instance will not be changed.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   * @param scope The scope of the metadata template. Example: "global"
   * @param templateKey The name of the metadata template. Example: "properties"
   * @param requestBody Request body of updateFileMetadataById method
   * @param headers Headers of updateFileMetadataById method
   */
  public MetadataFull updateFileMetadataById(
      String fileId,
      UpdateFileMetadataByIdScope scope,
      String templateKey,
      List<UpdateFileMetadataByIdRequestBody> requestBody,
      UpdateFileMetadataByIdHeaders headers) {
    Map<String, String> headersMap = prepareParams(mergeMaps(mapOf(), headers.getExtraHeaders()));
    FetchResponse response =
        this.networkSession
            .getNetworkClient()
            .fetch(
                new FetchOptions.Builder(
                        String.join(
                            "",
                            this.networkSession.getBaseUrls().getBaseUrl(),
                            "/2.0/files/",
                            convertToString(fileId),
                            "/metadata/",
                            convertToString(scope),
                            "/",
                            convertToString(templateKey)),
                        "PUT")
                    .headers(headersMap)
                    .data(JsonManager.serialize(requestBody))
                    .contentType("application/json-patch+json")
                    .responseFormat(ResponseFormat.JSON)
                    .auth(this.auth)
                    .networkSession(this.networkSession)
                    .build());
    return JsonManager.deserialize(response.getData(), MetadataFull.class);
  }

  /**
   * Deletes a piece of file metadata.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   * @param scope The scope of the metadata template. Example: "global"
   * @param templateKey The name of the metadata template. Example: "properties"
   */
  public void deleteFileMetadataById(
      String fileId, DeleteFileMetadataByIdScope scope, String templateKey) {
    deleteFileMetadataById(fileId, scope, templateKey, new DeleteFileMetadataByIdHeaders());
  }

  /**
   * Deletes a piece of file metadata.
   *
   * @param fileId The unique identifier that represents a file.
   *     <p>The ID for any file can be determined by visiting a file in the web application and
   *     copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
   *     `file_id` is `123`. Example: "12345"
   * @param scope The scope of the metadata template. Example: "global"
   * @param templateKey The name of the metadata template. Example: "properties"
   * @param headers Headers of deleteFileMetadataById method
   */
  public void deleteFileMetadataById(
      String fileId,
      DeleteFileMetadataByIdScope scope,
      String templateKey,
      DeleteFileMetadataByIdHeaders headers) {
    Map<String, String> headersMap = prepareParams(mergeMaps(mapOf(), headers.getExtraHeaders()));
    FetchResponse response =
        this.networkSession
            .getNetworkClient()
            .fetch(
                new FetchOptions.Builder(
                        String.join(
                            "",
                            this.networkSession.getBaseUrls().getBaseUrl(),
                            "/2.0/files/",
                            convertToString(fileId),
                            "/metadata/",
                            convertToString(scope),
                            "/",
                            convertToString(templateKey)),
                        "DELETE")
                    .headers(headersMap)
                    .responseFormat(ResponseFormat.NO_CONTENT)
                    .auth(this.auth)
                    .networkSession(this.networkSession)
                    .build());
  }

  public Authentication getAuth() {
    return auth;
  }

  public NetworkSession getNetworkSession() {
    return networkSession;
  }

  public static class Builder {

    protected Authentication auth;

    protected NetworkSession networkSession;

    public Builder() {
      this.networkSession = new NetworkSession();
    }

    public Builder auth(Authentication auth) {
      this.auth = auth;
      return this;
    }

    public Builder networkSession(NetworkSession networkSession) {
      this.networkSession = networkSession;
      return this;
    }

    public FileMetadataManager build() {
      return new FileMetadataManager(this);
    }
  }
}

1	package com.box.sdkgen.managers.filemetadata;
2
3	import static com.box.sdkgen.internal.utils.UtilsManager.convertToString;
4	import static com.box.sdkgen.internal.utils.UtilsManager.entryOf;
5	import static com.box.sdkgen.internal.utils.UtilsManager.mapOf;
6	import static com.box.sdkgen.internal.utils.UtilsManager.mergeMaps;
7	import static com.box.sdkgen.internal.utils.UtilsManager.prepareParams;
8
9	import com.box.sdkgen.networking.auth.Authentication;
10	import com.box.sdkgen.networking.fetchoptions.FetchOptions;
11	import com.box.sdkgen.networking.fetchoptions.ResponseFormat;
12	import com.box.sdkgen.networking.fetchresponse.FetchResponse;
13	import com.box.sdkgen.networking.network.NetworkSession;
14	import com.box.sdkgen.schemas.metadatafull.MetadataFull;
15	import com.box.sdkgen.schemas.metadatas.Metadatas;
16	import com.box.sdkgen.serialization.json.JsonManager;
17	import java.util.List;
18	import java.util.Map;
19
20	public class FileMetadataManager {
21
22	public Authentication auth;
23
24	public NetworkSession networkSession;
25
26	public FileMetadataManager() {	×
27	this.networkSession = new NetworkSession();	×
UNCOV 28	}	×
29
30	protected FileMetadataManager(Builder builder) {	×
31	this.auth = builder.auth;	×
32	this.networkSession = builder.networkSession;	×
UNCOV 33	}	×
34
35	/**
36	* Retrieves all metadata for a given file.
37	*
38	* @param fileId The unique identifier that represents a file.
39	* <p>The ID for any file can be determined by visiting a file in the web application and
40	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
41	* `file_id` is `123`. Example: "12345"
42	*/
43	public Metadatas getFileMetadata(String fileId) {
UNCOV 44	return getFileMetadata(fileId, new GetFileMetadataQueryParams(), new GetFileMetadataHeaders());	×
45	}
46
47	/**
48	* Retrieves all metadata for a given file.
49	*
50	* @param fileId The unique identifier that represents a file.
51	* <p>The ID for any file can be determined by visiting a file in the web application and
52	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
53	* `file_id` is `123`. Example: "12345"
54	* @param queryParams Query parameters of getFileMetadata method
55	*/
56	public Metadatas getFileMetadata(String fileId, GetFileMetadataQueryParams queryParams) {
57	return getFileMetadata(fileId, queryParams, new GetFileMetadataHeaders());	×
58	}
59
60	/**
61	* Retrieves all metadata for a given file.
62	*
63	* @param fileId The unique identifier that represents a file.
64	* <p>The ID for any file can be determined by visiting a file in the web application and
65	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
66	* `file_id` is `123`. Example: "12345"
67	* @param headers Headers of getFileMetadata method
68	*/
69	public Metadatas getFileMetadata(String fileId, GetFileMetadataHeaders headers) {
70	return getFileMetadata(fileId, new GetFileMetadataQueryParams(), headers);	×
71	}
72
73	/**
74	* Retrieves all metadata for a given file.
75	*
76	* @param fileId The unique identifier that represents a file.
77	* <p>The ID for any file can be determined by visiting a file in the web application and
78	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
79	* `file_id` is `123`. Example: "12345"
80	* @param queryParams Query parameters of getFileMetadata method
81	* @param headers Headers of getFileMetadata method
82	*/
83	public Metadatas getFileMetadata(
84	String fileId, GetFileMetadataQueryParams queryParams, GetFileMetadataHeaders headers) {
UNCOV 85	Map<String, String> queryParamsMap =	×
UNCOV 86	prepareParams(mapOf(entryOf("view", convertToString(queryParams.getView()))));	×
UNCOV 87	Map<String, String> headersMap = prepareParams(mergeMaps(mapOf(), headers.getExtraHeaders()));	×
UNCOV 88	FetchResponse response =	×
89	this.networkSession
UNCOV 90	.getNetworkClient()	×
UNCOV 91	.fetch(	×
92	new FetchOptions.Builder(
UNCOV 93	String.join(	×
94	"",
UNCOV 95	this.networkSession.getBaseUrls().getBaseUrl(),	×
96	"/2.0/files/",
UNCOV 97	convertToString(fileId),	×
98	"/metadata"),
99	"GET")
UNCOV 100	.params(queryParamsMap)	×
UNCOV 101	.headers(headersMap)	×
UNCOV 102	.responseFormat(ResponseFormat.JSON)	×
UNCOV 103	.auth(this.auth)	×
UNCOV 104	.networkSession(this.networkSession)	×
UNCOV 105	.build());	×
UNCOV 106	return JsonManager.deserialize(response.getData(), Metadatas.class);	×
107	}
108
109	/**
110	* Retrieves the instance of a metadata template that has been applied to a file.
111	*
112	* @param fileId The unique identifier that represents a file.
113	* <p>The ID for any file can be determined by visiting a file in the web application and
114	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
115	* `file_id` is `123`. Example: "12345"
116	* @param scope The scope of the metadata template. Example: "global"
117	* @param templateKey The name of the metadata template. Example: "properties"
118	*/
119	public MetadataFull getFileMetadataById(
120	String fileId, GetFileMetadataByIdScope scope, String templateKey) {
UNCOV 121	return getFileMetadataById(	×
122	fileId,
123	scope,
124	templateKey,
125	new GetFileMetadataByIdQueryParams(),
126	new GetFileMetadataByIdHeaders());
127	}
128
129	/**
130	* Retrieves the instance of a metadata template that has been applied to a file.
131	*
132	* @param fileId The unique identifier that represents a file.
133	* <p>The ID for any file can be determined by visiting a file in the web application and
134	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
135	* `file_id` is `123`. Example: "12345"
136	* @param scope The scope of the metadata template. Example: "global"
137	* @param templateKey The name of the metadata template. Example: "properties"
138	* @param queryParams Query parameters of getFileMetadataById method
139	*/
140	public MetadataFull getFileMetadataById(
141	String fileId,
142	GetFileMetadataByIdScope scope,
143	String templateKey,
144	GetFileMetadataByIdQueryParams queryParams) {
UNCOV 145	return getFileMetadataById(	×
146	fileId, scope, templateKey, queryParams, new GetFileMetadataByIdHeaders());
147	}
148
149	/**
150	* Retrieves the instance of a metadata template that has been applied to a file.
151	*
152	* @param fileId The unique identifier that represents a file.
153	* <p>The ID for any file can be determined by visiting a file in the web application and
154	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
155	* `file_id` is `123`. Example: "12345"
156	* @param scope The scope of the metadata template. Example: "global"
157	* @param templateKey The name of the metadata template. Example: "properties"
158	* @param headers Headers of getFileMetadataById method
159	*/
160	public MetadataFull getFileMetadataById(
161	String fileId,
162	GetFileMetadataByIdScope scope,
163	String templateKey,
164	GetFileMetadataByIdHeaders headers) {
UNCOV 165	return getFileMetadataById(	×
166	fileId, scope, templateKey, new GetFileMetadataByIdQueryParams(), headers);
167	}
168
169	/**
170	* Retrieves the instance of a metadata template that has been applied to a file.
171	*
172	* @param fileId The unique identifier that represents a file.
173	* <p>The ID for any file can be determined by visiting a file in the web application and
174	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
175	* `file_id` is `123`. Example: "12345"
176	* @param scope The scope of the metadata template. Example: "global"
177	* @param templateKey The name of the metadata template. Example: "properties"
178	* @param queryParams Query parameters of getFileMetadataById method
179	* @param headers Headers of getFileMetadataById method
180	*/
181	public MetadataFull getFileMetadataById(
182	String fileId,
183	GetFileMetadataByIdScope scope,
184	String templateKey,
185	GetFileMetadataByIdQueryParams queryParams,
186	GetFileMetadataByIdHeaders headers) {
UNCOV 187	Map<String, String> queryParamsMap =	×
188	prepareParams(mapOf(entryOf("view", convertToString(queryParams.getView()))));	×
UNCOV 189	Map<String, String> headersMap = prepareParams(mergeMaps(mapOf(), headers.getExtraHeaders()));	×
190	FetchResponse response =	×
191	this.networkSession
192	.getNetworkClient()	×
193	.fetch(	×
194	new FetchOptions.Builder(
195	String.join(	×
196	"",
197	this.networkSession.getBaseUrls().getBaseUrl(),	×
198	"/2.0/files/",
199	convertToString(fileId),	×
200	"/metadata/",
UNCOV 201	convertToString(scope),	×
202	"/",
UNCOV 203	convertToString(templateKey)),	×
204	"GET")
UNCOV 205	.params(queryParamsMap)	×
UNCOV 206	.headers(headersMap)	×
UNCOV 207	.responseFormat(ResponseFormat.JSON)	×
UNCOV 208	.auth(this.auth)	×
UNCOV 209	.networkSession(this.networkSession)	×
UNCOV 210	.build());	×
UNCOV 211	return JsonManager.deserialize(response.getData(), MetadataFull.class);	×
212	}
213
214	/**
215	* Applies an instance of a metadata template to a file.
216	*
217	* <p>In most cases only values that are present in the metadata template will be accepted, except
218	* for the `global.properties` template which accepts any key-value pair.
219	*
220	* @param fileId The unique identifier that represents a file.
221	* <p>The ID for any file can be determined by visiting a file in the web application and
222	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
223	* `file_id` is `123`. Example: "12345"
224	* @param scope The scope of the metadata template. Example: "global"
225	* @param templateKey The name of the metadata template. Example: "properties"
226	* @param requestBody Request body of createFileMetadataById method
227	*/
228	public MetadataFull createFileMetadataById(
229	String fileId,
230	CreateFileMetadataByIdScope scope,
231	String templateKey,
232	Map<String, Object> requestBody) {
UNCOV 233	return createFileMetadataById(	×
234	fileId, scope, templateKey, requestBody, new CreateFileMetadataByIdHeaders());
235	}
236
237	/**
238	* Applies an instance of a metadata template to a file.
239	*
240	* <p>In most cases only values that are present in the metadata template will be accepted, except
241	* for the `global.properties` template which accepts any key-value pair.
242	*
243	* @param fileId The unique identifier that represents a file.
244	* <p>The ID for any file can be determined by visiting a file in the web application and
245	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
246	* `file_id` is `123`. Example: "12345"
247	* @param scope The scope of the metadata template. Example: "global"
248	* @param templateKey The name of the metadata template. Example: "properties"
249	* @param requestBody Request body of createFileMetadataById method
250	* @param headers Headers of createFileMetadataById method
251	*/
252	public MetadataFull createFileMetadataById(
253	String fileId,
254	CreateFileMetadataByIdScope scope,
255	String templateKey,
256	Map<String, Object> requestBody,
257	CreateFileMetadataByIdHeaders headers) {
258	Map<String, String> headersMap = prepareParams(mergeMaps(mapOf(), headers.getExtraHeaders()));	×
UNCOV 259	FetchResponse response =	×
260	this.networkSession
UNCOV 261	.getNetworkClient()	×
262	.fetch(	×
263	new FetchOptions.Builder(
264	String.join(	×
265	"",
266	this.networkSession.getBaseUrls().getBaseUrl(),	×
267	"/2.0/files/",
268	convertToString(fileId),	×
269	"/metadata/",
270	convertToString(scope),	×
271	"/",
272	convertToString(templateKey)),	×
273	"POST")
274	.headers(headersMap)	×
275	.data(JsonManager.serialize(requestBody))	×
276	.contentType("application/json")	×
277	.responseFormat(ResponseFormat.JSON)	×
UNCOV 278	.auth(this.auth)	×
UNCOV 279	.networkSession(this.networkSession)	×
UNCOV 280	.build());	×
UNCOV 281	return JsonManager.deserialize(response.getData(), MetadataFull.class);	×
282	}
283
284	/**
285	* Updates a piece of metadata on a file.
286	*
287	* <p>The metadata instance can only be updated if the template has already been applied to the
288	* file before. When editing metadata, only values that match the metadata template schema will be
289	* accepted.
290	*
291	* <p>The update is applied atomically. If any errors occur during the application of the
292	* operations, the metadata instance will not be changed.
293	*
294	* @param fileId The unique identifier that represents a file.
295	* <p>The ID for any file can be determined by visiting a file in the web application and
296	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
297	* `file_id` is `123`. Example: "12345"
298	* @param scope The scope of the metadata template. Example: "global"
299	* @param templateKey The name of the metadata template. Example: "properties"
300	* @param requestBody Request body of updateFileMetadataById method
301	*/
302	public MetadataFull updateFileMetadataById(
303	String fileId,
304	UpdateFileMetadataByIdScope scope,
305	String templateKey,
306	List<UpdateFileMetadataByIdRequestBody> requestBody) {
UNCOV 307	return updateFileMetadataById(	×
308	fileId, scope, templateKey, requestBody, new UpdateFileMetadataByIdHeaders());
309	}
310
311	/**
312	* Updates a piece of metadata on a file.
313	*
314	* <p>The metadata instance can only be updated if the template has already been applied to the
315	* file before. When editing metadata, only values that match the metadata template schema will be
316	* accepted.
317	*
318	* <p>The update is applied atomically. If any errors occur during the application of the
319	* operations, the metadata instance will not be changed.
320	*
321	* @param fileId The unique identifier that represents a file.
322	* <p>The ID for any file can be determined by visiting a file in the web application and
323	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
324	* `file_id` is `123`. Example: "12345"
325	* @param scope The scope of the metadata template. Example: "global"
326	* @param templateKey The name of the metadata template. Example: "properties"
327	* @param requestBody Request body of updateFileMetadataById method
328	* @param headers Headers of updateFileMetadataById method
329	*/
330	public MetadataFull updateFileMetadataById(
331	String fileId,
332	UpdateFileMetadataByIdScope scope,
333	String templateKey,
334	List<UpdateFileMetadataByIdRequestBody> requestBody,
335	UpdateFileMetadataByIdHeaders headers) {
UNCOV 336	Map<String, String> headersMap = prepareParams(mergeMaps(mapOf(), headers.getExtraHeaders()));	×
UNCOV 337	FetchResponse response =	×
338	this.networkSession
339	.getNetworkClient()	×
UNCOV 340	.fetch(	×
341	new FetchOptions.Builder(
UNCOV 342	String.join(	×
343	"",
UNCOV 344	this.networkSession.getBaseUrls().getBaseUrl(),	×
345	"/2.0/files/",
UNCOV 346	convertToString(fileId),	×
347	"/metadata/",
348	convertToString(scope),	×
349	"/",
350	convertToString(templateKey)),	×
351	"PUT")
UNCOV 352	.headers(headersMap)	×
353	.data(JsonManager.serialize(requestBody))	×
354	.contentType("application/json-patch+json")	×
UNCOV 355	.responseFormat(ResponseFormat.JSON)	×
UNCOV 356	.auth(this.auth)	×
UNCOV 357	.networkSession(this.networkSession)	×
358	.build());	×
359	return JsonManager.deserialize(response.getData(), MetadataFull.class);	×
360	}
361
362	/**
363	* Deletes a piece of file metadata.
364	*
365	* @param fileId The unique identifier that represents a file.
366	* <p>The ID for any file can be determined by visiting a file in the web application and
367	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
368	* `file_id` is `123`. Example: "12345"
369	* @param scope The scope of the metadata template. Example: "global"
370	* @param templateKey The name of the metadata template. Example: "properties"
371	*/
372	public void deleteFileMetadataById(
373	String fileId, DeleteFileMetadataByIdScope scope, String templateKey) {
UNCOV 374	deleteFileMetadataById(fileId, scope, templateKey, new DeleteFileMetadataByIdHeaders());	×
UNCOV 375	}	×
376
377	/**
378	* Deletes a piece of file metadata.
379	*
380	* @param fileId The unique identifier that represents a file.
381	* <p>The ID for any file can be determined by visiting a file in the web application and
382	* copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the
383	* `file_id` is `123`. Example: "12345"
384	* @param scope The scope of the metadata template. Example: "global"
385	* @param templateKey The name of the metadata template. Example: "properties"
386	* @param headers Headers of deleteFileMetadataById method
387	*/
388	public void deleteFileMetadataById(
389	String fileId,
390	DeleteFileMetadataByIdScope scope,
391	String templateKey,
392	DeleteFileMetadataByIdHeaders headers) {
UNCOV 393	Map<String, String> headersMap = prepareParams(mergeMaps(mapOf(), headers.getExtraHeaders()));	×
UNCOV 394	FetchResponse response =	×
395	this.networkSession
UNCOV 396	.getNetworkClient()	×
UNCOV 397	.fetch(	×
398	new FetchOptions.Builder(
UNCOV 399	String.join(	×
400	"",
UNCOV 401	this.networkSession.getBaseUrls().getBaseUrl(),	×
402	"/2.0/files/",
UNCOV 403	convertToString(fileId),	×
404	"/metadata/",
UNCOV 405	convertToString(scope),	×
406	"/",
UNCOV 407	convertToString(templateKey)),	×
408	"DELETE")
UNCOV 409	.headers(headersMap)	×
UNCOV 410	.responseFormat(ResponseFormat.NO_CONTENT)	×
UNCOV 411	.auth(this.auth)	×
UNCOV 412	.networkSession(this.networkSession)	×
UNCOV 413	.build());	×
UNCOV 414	}	×
415
416	public Authentication getAuth() {
UNCOV 417	return auth;	×
418	}
419
420	public NetworkSession getNetworkSession() {
UNCOV 421	return networkSession;	×
422	}
423
424	public static class Builder {
425
426	protected Authentication auth;
427
428	protected NetworkSession networkSession;
429
UNCOV 430	public Builder() {	×
UNCOV 431	this.networkSession = new NetworkSession();	×
UNCOV 432	}	×
433
434	public Builder auth(Authentication auth) {
UNCOV 435	this.auth = auth;	×
UNCOV 436	return this;	×
437	}
438
439	public Builder networkSession(NetworkSession networkSession) {
UNCOV 440	this.networkSession = networkSession;	×
UNCOV 441	return this;	×
442	}
443
444	public FileMetadataManager build() {
UNCOV 445	return new FileMetadataManager(this);	×
446	}
447	}
448	}

box / box-java-sdk / #5862

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous